[Java] (Project, Package, Class, Method) Naming κ·μΉ
곡ν΅
- λμλ¬Έμκ° κ΅¬λΆλλ©° κΈΈμ΄μ μ νμ΄ μλ€.
- μμ½μ΄λ₯Ό μ¬μ©ν΄μλ μ λλ€.
- μ«μλ‘ μμν΄μλ μ λλ€.
- νΉμλ¬Έμλ '_' νΉμ '$'λ§ νμ©νλ€.
- νμ€μΉΌ νκΈ°λ²(PascalCase)κ³Ό μΉ΄λ© νκΈ°λ²(camelCase)μ μ¬μ©νλ€.
- λ°μμ΄λ λ°λμ λμνλ κ°λ μΌλ‘ μ¬μ©ν΄μΌ νλ€.
1. Project(νλ‘μ νΈ)
- λ/μλ¬Έμ ꡬλΆμμ΄ μμ κ°λ₯νλ€.
- λλ¬Έμ μ¬μ©μ κΆμ₯νλ€.
2. Package(ν¨ν€μ§)
- ν¨ν€μ§λͺ μ λμλ¬Έμλ₯Ό λͺ¨λ νμ© νμ§λ§ ν΄λμ€λͺ κ³Ό μ½κ² ꡬλΆνκΈ° μν΄μ μλ¬Έμλ‘ νλ κ²μ μμΉ μΌλ‘ νκ³ μλ€.
- νμ€ ν¨ν΄μ λ°λ₯Έλ€. Ex) [com].[Company].[Project].[toppackage].[lowerpackage]
- κ°κΈμ ν λ¨μ΄ μ¬μ©μ κΆμ₯νλ€.
- μ’μ μ: com.nexon.maplestory.member.object
- λμ μ: com.nexon.maplestoryMemberObject
3. Class(ν΄λμ€)
- νμ€μΉΌ νκΈ°λ²μ μ¬μ©νλ€.
- λͺ μ¬λ‘ μμνλ€.
- Ex) HelloWorld, TestWorld, ByeClass
4. interface(μΈν°νμ΄μ€)
- νΉλ³ν μ λμ¬λ μ λ―Έμ¬λ₯Ό μ¬μ©νμ§ μκ³ νμ€μΉΌ νκΈ°λ²μ μ¬μ©νλ€.
- νμ©μ¬λ₯Ό μ¬μ©νλ€.
- Ex) Runnable, Remote λ±
5. Methods(λ©μλ)
- μΉ΄λ© νκΈ°λ²μ μ¬μ©νλ€.
- λμ¬λ‘ μμνλ€.
5.1) μμ±μ μ κ·Όνλ λ©μλ λͺ
μ μ λμ¬λ 'get','set'μ μ¬μ©νλ€.
(ex. public void setDisplayName)
(ex. public void getDisplayName)
5.2) λ°μ΄ν°λ₯Ό μ‘°ννλ λ©μλλͺ
μ μ λμ¬λ findλ₯Ό μ¬μ©νλ€.
(ex. public void findData(String data){})
5.3) λ°μ΄ν°λ₯Ό μ
λ ₯νλ λ©μλλͺ
μ μ λμ¬λ inputμ μ¬μ©νλ€.
(ex. public void inputData(HashMap data){})
5.4) λ°μ΄ν°λ₯Ό λ³κ²½νλ λ©μλλͺ
μ μ λμ¬λ modifyλ₯Ό μ¬μ©νλ€.
(ex. public void modifyData(HashMap data){})
5.5) λ°μ΄ν°λ₯Ό μμ νλ λ©μλλͺ
μ μ λμ¬λ deleteλ₯Ό μ¬μ©νλ€.
(ex. public void deleteData(String data){})
5.6) λ°μ΄ν°λ₯Ό μ΄κΈ°ννλ λ©μλ λͺ
μ μ λμ¬λ initializeμ μ¬μ©νλ€.
(ex. public void initData(String data){})
5.7) λ°ν κ°μ νμ
μ΄ booleanμΈ λ©μλλ μ λμ¬λ‘ isλ₯Ό μ¬μ©νλ€.
(ex. public void isData(String Data){})
5.8) λ°μ΄ν°λ₯Ό λΆλ¬μ€λ λ©μλ λͺ
μ μ λμ¬λ loadλ₯Ό μ¬μ©νλ€.
(ex. public void loadData(){})
5.9) λ°μ΄ν°κ° μλμ§ νμΈνλ λ©μλλͺ
μ μ λμ¬λ hasλ₯Ό μ¬μ©νλ€.
(ex. public void hasData(){})
5.10) μλ‘μ΄ κ°μ²΄λ₯Ό λ§λ λ€ ν΄λΉ κ°μ²΄λ₯Ό 리ν΄ν΄μ£Όλ λ©μλ λͺ
μ μ λμ¬λ createλ₯Ό μ¬μ©νλ€.
(ex. public void createAccount(){})
5.11) ν΄λΉ κ°μ²΄λ₯Ό λ€λ₯Έ ννμ κ°μ²΄λ‘ λ³νν΄μ£Όλ λ©μλ λͺ
μ μ λμ¬λ toλ₯Ό μ¬μ©νλ€.
(ex. public void toString(){})
5.12) ν΄λΉ κ°μ²΄κ° 볡μμΈμ§ λ¨μΌμΈμ§ ꡬλΆνλ λ©μλ λͺ
μ μ λ―Έμ¬λ sλ₯Ό μ¬μ©νλ€.
(ex. public void getMembers(){})
5.13) Bλ₯Ό κΈ°μ€μΌλ‘ Aλ₯Ό νκ² λ€λ λ©μλλͺ
μ μ μΉμ¬λ Byλ₯Ό μ¬μ©νλ€.
(ex. public void getUserByName(String name){})
6) Variable(λ³μ)
- μλ¬Έμλ‘ μμνλ€.
- μΉ΄λ© νκΈ°λ²μ μ¬μ©νλ€.
- ex) firstName , lastName , birthday λ±
7. Constant(μμ)
- μ λΆ λλ¬Έμλ‘ νκΈ°νλ€.
- μ€λ€μ΄ν¬μΌμ΄μ€λ₯Ό μ¬μ©νμ¬ '_'λ‘ κ΅¬λΆνλ€.
- ex) MAX_PRIORITY , LIFESPAN λ±