# 2. Java Naming Conventions

# 코딩 순서

package -> import -> code 순으로 코딩합니다.

변수는 public -> protected -> package -> private 순으로 기록합니다.

참고로 자바에서는 아래 두 코드가 같은 동작을 합니다.

int[] a = new int[20]; // 보통의 방식
int a[] = new int[20]; // 권장히지 않음, 옛날의 C언어 방식

 

---

# Comment

참고로 /** ~ */ 를 사용하면 JavaDoc 이 자동으로 생성됩니다.

    /**
        * 메서드 설명
        *
        * @param name 삭제할 유저 이름
        * @return 유저가 존재해서 삭제가 되면 true를 리턴하고, 유저가 존재하지 않으면 false를 리턴한다.
        * @throws Exception 그냥 테스트용으로 했음.
   */
   public boolean removeUserName(String name){

   }

    /**
    * class 설명
    *
    * @author 김지원
    * @since 2021.04.03
    * @version 1.0
    * <pre>
    * 2021.04.03 : 최초 작성
    * 2021.04.04 : 컬렉션 추가
    * </pre>
    */
    public class DocExample {
    
    }

코드 위에 주석을 작성하는 것이 일반적입니다. 또한 메서드명, 변수명으로 기능을 확실하게 알 수 있다면, 주석을 작성하지 않아도 괜찮습니다.

 package example;

    import java.util.ArrayList;
    import java.util.Collection;

    /**
    * JavaDoc 테스트용 클래스입니다.
    *
    * @author 김지원
    * @since 2021.04.03
    * @version 1.0
    * <pre>
    * 2021.04.03 : 최초 작성
    * 2021.04.04 : 컬렉션 추가
    * </pre>
    */
    public class DocExample {

        private Collection<String> userNames;

        public DocExample(String name) {
            userNames = new ArrayList<String>();
        }

        /**
        * 유저 이름을 삭제하는 메서드
        *
        * @param name 삭제할 유저 이름
        * @return 유저가 존재해서 삭제가 되면 true를 리턴하고, 유저가 존재하지 않으면 false를 리턴한다.
        * @throws Exception 그냥 테스트용으로 했음.
        */
        public boolean removeUserName(String name)
        throws Exception {
            return userNames.remove(name);
        }

        /**
        * 어노테이션과 함께 쓸 때를 위한 예제 메서드
        *
        * @return 그냥 텍스트가 출력됨
        */
        @Override
        public String toString() {
            return "테스트용입니다.";
        }
    }

 

---

# General Naming Conventions

1. <패키지> 소문자로만 사용하세요.

mypackage, com.company.application.ui

 

2. <변수> 소문자로 시작하고, camelCase 명사로 지어주세요.

영어 소문자로 시작하고, 단어가 바뀌는 부분은 camelCase로 처리합니다.

line, myValue, audioSystem, isDone

 

3. <상수> (final) 대문자로만 쓰세요. 여러 단어는 언더바(_)를 사용합니다.

단, 대부분의 경우에는 상수는 메서드를 통해 제공하는 것을 권장합니다.

MAX_VALUE,  COLOR_RED

int getMaxValue() { // NOT : MAX_VALUE = 25
    return 25;
}

아래 같은 경우 숫자를 직접 사용하기보단, 상수를 활용하여 의미를 명확하게 만들어 주는 것이 좋습니다.

private static final int TEAM_SIZE = 11;
Player[] players = new Player[TEAM_SIZE]; // NOT: Player[] players = new Player[11];

 

4. <메서드> 소문자로 시작하고, 동사로 지어주세요.

getName(); computeTotalWidth();

 

5. <약어>도 되도록이면 camelCase를 지켜주세요.

보통의 경우 이렇게 하는 것이 가독성이 더 좋습니다.

exportHtmlSource(); // NOT: exportHTMLSource();
openDvdPlayer(); // NOT: openDVDPlayer();

 

6. 일반적인 변수는 가능하면 타입과 변수명을 동일하게 만드세요.

void setTopic(Topic topic) // NOT: void setTopic(Topic value)
// NOT: void setTopic(Topic aTopic)
// NOT: void setTopic(Topic t)
void connect(Database database) // NOT: void connect(Database db)
// NOT: void connect(Database oracleDB)

 

 

7. 사용범위가 넓은 변수는 이름을 길게, 잠깐 사용하면 짧게 지으세요.

단순 루프문에 사용될 변수를 loopIndexNumber 와 같이 지을 필요는 없습니다. i, j, k 로도 충분합니다.

다만 여러 클래스에서 사용되는 변수는 조금 길어도 괜찮으니 해당 변수의 의미를 명확하게 지어주세요. 

 

8. object의 이름에서 유추할 수 있는 내용은 생략하는 것이 좋습니다.

line.getLength(); // NOT: line.getLineLength();
person.getName(); // NOT: person.getPersonName();

 

---

# Specific Naming Conventions

1. get, set으로 시작하는 메서드는 getter와 setter에만 사용해주세요.

employee.getName();
employee.setName(name);
matrix.getElement(2, 4);
matrix.setElement(2, 4, value);

 

2. is로 시작하면 boolean 타입을 리턴해주세요.

물론 사용하는 변수의 역할에 따라 has, can, should 도 괜찮습니다.

isSet, isVisible, isFinished, isFound, isOpen

// boolen 파라메터를 사용하는 메서드
void setFound(boolean isFound);

boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;

 

3. 값을 계산하는 경우 compute 를 붙여주세요.

계산 결과가 있을 경우 그 값을 저장할 변수명을 result 로 짓는 것이 좋습니다.

valueSet.computeAverage();
matrix.computeInverse();

 

4. 자료구조에서 값을 찾는 경우 find 를 붙여주세요.

vertex.findNearestVertex();
matrix.findSmallestElement();
node.findShortestPath(Node destinationNode);

 

5. 어떤 작업의 초기화는 initalize를 붙여주세요.

init이라고 줄여서 사용하지 않는 것을 권장합니다.

printer.initializeFontSet();

 

6. GUI 컴포넌트들은 이름 뒤에 component 타입을 붙여주세요.

widthScale, nameTextField, leftScrollbar, mainPanel, fileToggle, minLabel

 

7. collection 이나 배열 타입은 복수형(-s)을 사용하세요.

Collection<Point> points;
int[] values;

 

8. 개수를 나타내는 변수의 경우 앞에 n을 붙여주세요.

num이라고 사용하는 것은 좋지않습니다. 가독성이 별로라면 차라리 numberOf 키워드를 사용하세요.

nPoints, nLines

 

9. 객체나 엔티티의 번호를 나타낼 경우 No를 뒤에 붙여주세요.

또는 iterable하게 사용한다면 앞에 i (iTable, iEmployee)를 붙이는 것도 괜찮습니다.

tableNo, employeeNo

 

10. 한 클래스 내에서 대응되는 단어 set을 사용하세요.

get/set, add/remove, create/destroy, start/stop, insert/delete,
increment/decrement, old/new, begin/end, first/last, up/down, min/max,
next/previous, old/new, open/close, show/hide, suspend/resume, etc.

 

11. 헷갈릴 수 있는 약자나 축약형을 쓰지마세요.

자바에서는 되도록이면 축약형을 쓰지 않는 것을 권장합니다.

computeAverage(); // NOT: compAvg();
ActionEvent event; // NOT: ActionEvent e;
catch (Exception exception) { // NOT: catch (Exception e) {

물론 프로젝트 내에서 헷갈릴 일이 없는 단어들은 축약형으로 쓰셔도 됩니다.

HypertextMarkupLanguage =>  html
CentralProcessingUnit => cpu
PriceEarningRatio => pe

 

12. boolean 타입을 부정적인 의미로 쓰지마세요.

No, Not을 사용하면 가독성이 떨어집니다. 기본값을 true라고 생각하고 사용해주세요.

bool isError; // NOT: isNoError
bool isFound; // NOT: isNotFound

 

13. Singleton 패턴을 구현한 클래스는 getInstance를 붙입니다.

class UnitManager {
    private final static UnitManager instance_ = new UnitManager();
    private UnitManager() {
        ...
    }
    public static UnitManager getInstance() { // NOT: get() or instance() or unitManager() etc.
        return instance_;
    }
}

 

14. Factory 패턴을 구현한 클래스는  new 를 붙입니다.

class PointFactory {
    public Point newPoint(...) {
        ...
    }
}

 

15. 리턴 타입이 있다면 처리 후 무엇을 리턴하는지 적어주세요.

반대로 리턴 타입이 없다면(void) 무엇을 처리하는지 적는 것이 좋습니다.