출처: http://www.javastudy.co.kr/docs/lec_ProgrammingGuide/okshin/JavaCodeConventions.htm

1. 개요

왜 code convention이 필요한가?
Code convention은 여러 가지 이유에서 프로그래머에게 중요하다 :

2. 파일 이름

이 절은 흔하게 사용되는 파일 확장자와 파일 이름을 보여준다.

2.1. 파일 확장자

자바 소프트웨어는 다음의 파일 확장자를 사용한다:

2.2. 공통으로 쓰이는 파일 이름

공통으로 다음과 같은 파일 이름을 사용한다:

3. 파일 구조

파일은 각각의 절을 구별할 수 있는 임의의 주석과 빈 줄에 의해 나누어지는 절들로 구성된다.
2000 라인 이상이 되는 파일들은 부담이 되므로 피해야 한다.
적절하게 구성된 자바 프로그램의 예제는, “11.1 Java Source File Example”을 보면 된다.

3.1. 자바 소스 파일

각각의 자바 소스 파일은 하나의 public 클래스 또는 인터페이스를 가진다. Private클래스들과 인터페이스들이 public클래스와 연결되어 있을 때, public클래스와 같은 파일에 private클래스들과 인터페이스들을 넣을 수 있다. Public 클래스는 파일에서 첫번째 클래스 또는 인터페이스이어야 한다.
자바 소스 파일은 다음과 같은 순서를 가진다.

3.1.1. 시작 주석

모든 소스 파일은 클래스 이름, 버전 정보, 날짜, 저작권 주의를 보여주는 C 스타일의 주석과 함께 시작하기로 한다. 

   1 /*
   2  * 클래스이름
   3  *
   4  * 버전 정보
   5  *
   6  * 날짜
   7  *
   8  * 저작권 주의
   9  */

3.1.2. Package 문장과 Import 문장

대부분의 자바 소스 파일의 주석이 아닌 첫번째 라인은 package문장이다. 그 후에, import문장이 뒤따라 나온다. 예를 들면 : 

   1 package java.awt;
   2 
   3 import java.awt.peer.CanvasPeer;

알림 : 유일한 패키지 이름의 첫번째 부분은 모두 소문자 ASCII문자로 쓰여지고, 첫번째 레벨의 도메인 이름들(com, edu, gov, mil, net, org)중에 하나이거나 1981년 ISO Standard 3166에서 정의된 영어 두 문자 코드인 나라 구별 코드 중에 하나이어야 한다.

3.1.3. 클래스와 인터페이스 선언

다음의 테이블은 클래스 또는 인터페이스 선언의 일부분들을 나타나는 순서에 따라 보여준다.

클래스/인터페이스BR선언의 일부분

설명

1

클래스/인터페이스 문서 주석BR(/**...*/)

이 주석에서 나타나야 하는 정보들은 “5.2 문서 주석”을 참고하여라.

2

클래스/인터페이스 문장

3

필요할 경우, 클래스/인터페이스 구현 주석 (/*...*/)

이 주석은 클래스/인터페이스 문서 주석에 적합하지 않은 하나의 클래스 또는 인터페이스 범위의 정보들을 포함해야 한다.

4

클래스(static) 변수

첫번째로는 public 클래스 변수들이 나오고, 그 다음에 protected클래스 변수들, 그 다음에 package(접근자가 없는 경우) 클래스 변수들, 그 다음에 private클래스 변수들이 나온다.

5

일반 변수

나오는 순서는 클래스 변수와 동일하다.

6

생성자

7

메서드

메서드들은 범위나 접근성에 의해서 보다는 기능성에 의해서 그룹 되어져야 한다. 예를 들어, private클래스 메서드가 두 개의 public 메서드들 사이에 존재할 수도 있다. 이렇게 하는 목적은 코드를 더 쉽게 이해하고 더 쉽게 읽기 위해서 이다.

4. 들여쓰기

4개의 스페이스가 들여쓰기의 단위로 사용되어져야 한다. 들여쓰기의 정확한 구조(스페이스대 탭)는 정해여 있지 않다. 탭은 4개가 아니라 8개의 스페이스로 모두 설정해야 한다.

4.1. 한 줄의 길이

한 줄에 80자 이상 쓰는 것은 대부분의 터미널과 툴에서 다룰 수 없기 때문에 피해야 한다.
노트 : 문서에서 사용하는 예제는 일반적으로 한 줄에 70자 이상을 가지지 않는다.

4.2. 줄 나누기

Expression이 한 줄에 들어가지 않을 때에는, 다음과 같은 일반적인 원칙들을 따라서 두 줄로 분리한다.

여기 메서드 호출을 분리하는 약간의 예제들이 있다. 

   1 someMethod(longExpression1, longExpression2, longExpression3,
   2         longExpression4, longExpression5);
   3 
   4 var = someMethod1(longExpression1,
   5                 someMethod2(longExpression2,
   6                         longExpression3));

다음은 수학 표현식을 분리하는 두 개의 예제이다. 첫번째 예제가 괄호로 싸여진 표현식 밖에서 분리가 일어나고 더 높은 레벨이기 때문에 첫번째 예제를 더 많이 사용한다. 

   1 longName1 = longName2 * (longName3 + longName4 - longName5)
   2         + 4 * longname6; // 될 수 있으면 더 많이 사용한다.
   3 
   4 longName1 = longName2 * (longName3 + longName4
   5                          - longName5) + 4 * longname6; // 될 수 있으면 피한다.
   6

다음은 메서드 선언들을 들여 쓰는 예제들이다. 첫번째는 평범한 경우이다. 두 번째 예제의 경우 평범한 들여쓰기를 사용한다면 두 번째 줄과 세 번째 줄을 더 멀리 들여 써야 하지만, 대신에 단지 8개의 스페이스를 들여 썼다. 

   1 // 평범한 들여쓰기
   2 someMethod(int anArg, Object anotherArg, String yetAnotherArg,
   3            Object andStillAnother) {
   4     ...
   5 }
   6 
   7 // 너무 멀리 들여 쓰는 것을 피하기 위해 8개의 스페이스 들여쓰기
   8 private static synchronized horkingLongMethodName(int anArg,
   9         Object anotherArg, String yetAnotherArg,
  10         Object andStillAnother) {
  11     ...
  12 }

보통의 메서드 본문 들여쓰기(4개의 스페이스)와 구분하기 위해서 문장 들여쓰기는 일반적으로 8-스페이스 원칙을 사용한다. 예를 들어 : 

   1 // 아래와 같은 들여쓰기는 사용하지 말아라.
   2 if ((condition1 && condition2)
   3     || (condition3 && condition4)
   4     ||!(condition5 && condition6)) { // 안 좋은 들여쓰기
   5     doSomethingAboutIt();            // 이 줄은 명확하지가 않다.
   6 }
   7 
   8 // 대신에 아래와 같은 들여쓰기를 사용한다.
   9 if ((condition1 && condition2)
  10         || (condition3 && condition4)
  11         ||!(condition5 && condition6)) {
  12     doSomethingAboutIt();
  13 }
  14 
  15 // 또는 아래와 같은 들여쓰기를 사용한다.
  16 if ((condition1 && condition2) || (condition3 && condition4)
  17         ||!(condition5 && condition6)) {
  18     doSomethingAboutIt();
  19 }

다음은 ternary expression에서 사용하는 받아 들일 만한 세 가지 방법이다 : 

   1 alpha = (aLongBooleanExpression) ? beta : gamma;
   2 
   3 alpha = (aLongBooleanExpression) ? beta
   4                                  : gamma;
   5 
   6 alpha = (aLongBooleanExpression)
   7         ? beta
   8         : gamma;

5. 주석

자바 프로그램은 두 가지 종류의 주석을 가진다 : 구현 주석과 문서 주석. 구현 주석은 /*…*/과 //에 의해서 경계가 결정되는 C++에서의 주석과 같다. 문서 주석(doc comments로 잘 알려진)은 단지 자바에서만 사용되며, /**…*/에 의해서 경계가 결정된다. Doc comments는 javadoc 툴을 사용하여 HTML파일로 뽑아낼 수 있다.

구현 주석은 개별적인 구현에 대한 주석 또는 코드와는 상관없는 주석을 의미한다. Doc comment는 소스 코드가 없는 개발자들도 읽을 수 있도록 구현에 종속되지 않는 코드에 대한 명세 사항을 표현하는 것을 의미한다.

주석은 코드에 대한 개요와 코드 자체만 가지고 이용할 수 없는 추가적인 정보들을 제공하기 위해 사용되어져야 한다. 주석은 프로그램을 읽는 것과 이해하는 것에 관계된 정보만을 포함하고 있어야 한다. 예를 들어, ‘패키지를 어떻게 만들 것인가?’ 또는 ‘파일들을 어느 디렉토리에 위치시킬 것인가?’에 대한 정보는 주석으로 포함되어서는 안 된다.

사소한 것도 아닌데, 분명하지 않을 경우의 설계 결정에 대하여 쓰는 것은 적절하지만, 그러나 코드 상에 존재하는 중복 정보는 피해야 한다. 중복된 주석을 작성하는 경우가 빈번하기 일어나기 쉽게 때문에 제 시간에 프로그램을 완성할 수 없는 경우가 많다. 코드가 포함함으로써 날짜를 어길 것 같은 주석은 피해야 한다.

노트 : 주석의 빈번한 발생은 때때로 코드의 질을 떨어뜨리기도 한다. 주석을 추가해야만 한다고 느낄 때, 코드를 더 확실히 재 작성하는 것을 고려해 보아라.

주석을 별표 또는 다른 문자를 이용하여 그려진 큰 사각형에 넣어서는 안 된다.

주석은 form-feed 와 backspace같은 특수 문자를 포함해서는 안 된다.

5.1. 구현 주석 형식

프로그램은 4가지 스타일의 구현주석을 가질 수 있다 : block, single-line, trailing, 그리고 end-of-line.

5.1.1. Block 주석

Block 주석은 파일, 메서드, 자료 구조, 알고리즘들의 설명을 제공할 때 사용된다. Block 주석은 각각의 파일이 시작될 때와 메서드 전에 사용된다. 또한 메서드 안에서와 같이 다른 장소에서 사용되어질 수도 있다. 메서드 안에 존재하는 Block 주석은 그것들이 설명하는 코드와 같은 레벨로 들여쓰기를 해야 한다.

Block 주석은 코드의 나머지로부터 분리하기 위해서 처음 한 줄을 비워야 한다. 

   1 /*
   2  * 여기에 block comment를 작성한다.
   3  */

Block 주석의 형식을 고치는 일이 일어나지 않는 특별한 block 주석은 /*- 시작할 수 있다. 예를 들어 : 

   1 /*-
   2  * 여기에 들여쓰기가 무시되어야 하는 아주 특별한
   3  * block 주석을 작성한다.
   4  *
   5  *    one
   6  *        two
   7  *            three
   8  */

5.1.2. Single-Line 주석

짧은 주석은 뒤따라 오는 코드와 같은 레벨의 들여쓰기를 하는 한 줄로 나타날 수 있다. 만약 주석이 한 줄에 써지지 않는다면, block 주석 형식을 따라야 한다. (“5.1.1 Block 주석“을 보아라.) Single-line 주석은 빈 줄로 시작되어야 한다. 다음은 자바 코드에서 single-line 주석의 예제이다 : 

   1 if (condition) {
   2 
   3     /* Handle the condition. */
   4     ...
   5 }

5.1.3. Trailing 주석

매우 짧은 주석의 경우 주석이 설명하는 코드와 같은 줄에 나타난다. 하지만 진짜 코드와 구별될 만큼 충분히 멀리 떨어뜨려야 한다.

다음은 자바 코드에서 trailing 주석의 예제이다 : 

   1 if (a == 2) {
   2     return TRUE;            /* special case */
   3 } else {
   4     return isPrime(a);      /* works only for odd a */
   5 }

5.1.4. End-Of-Line 주석

주석 기호 // 는 한 줄 모두를 주석 처리하거나 한 줄의 일부분을 주석 처리할 수 있다. 이 주석은 본문 주석을 위하여 여러 줄에 연속되어 사용되어지면 안되지만, 코드의 섹센을 주석 처리하기 위하여 여러 줄에 연속되어 사용되어질 수 있다. 다음은 이 주석의 세가지 스타일 예제이다 : 

   1 if (foo > 1) {
   2 
   3     // Do a double-flip.
   4     ...
   5 }
   6 else {
   7     return false;          // Explain why here.
   8 }
   9 //if (bar > 1) {
  10 //
  11 //    // Do a triple-flip.
  12 //    ...
  13 //}
  14 //else {
  15 //    return false;
  16 //}
  17

5.2. 문서 주석

노트 : 여기에서 나타나는 주석들의 예제는 “11.1 Java Source File Example“을 보아라.

Doc 주석은 자바 클래스, 인터페이스, 생성자, 메서드 그리고 필드들을 설명한다. 각각의 doc 주석은 주석 경계 기호인 /**…*/ 안으로 들어간다. 그리고, 각각의 doc 주석은 클래스, 인터페이스 그리고 멤버 당 하나씩 가진다. Doc 주석은 선언 바로 전에 나와야 한다. 다음은 예제이다 : 

   1 /**
   2  * The Example class provides ...
   3  */
   4 public class Example { ...

최고 레벨의 클래스와 인터페이스들은 들여 쓰지 않는 반면에 그들의 멤버들은 들여쓰기를 한다. 클래스에 대한 doc 주석(/**)의 첫 번째 줄은 들여 쓰지 않는다 ; 그 다음에 나오는 doc 주석은 별표를 수직으로 맞추기 위해 각각 1개의 space 들여쓰기를 가진다. 생성자를 포함한 멤버들은 doc 주석 첫 줄에서는 4개의 space 들여쓰기를 하고, 그 이후에는 5개의 space들여쓰기를 한다.

만약 문서 주석에 적절하지 않은 클래스, 인터페이스, 변수 도는 메서드에 대한 정보를 제공하고 싶다면, 선언 후에 바로 구현 block 주석(5.1.1 Block 주석을 보아라.) 또는 single-line주석(5.1.2 Single-Line 주석)을 사용한다. 예를 들어, 클래스의 구현에 대한 세부 사항들은 클래스 doc 주석이 아니라, class 문장 다음에 구현 block 주석을 사용해야 한다.

자바는 문서 주석을 주석이후 처음 나오는 선언문과 연결시키기 때문에 doc 주석은 메서드 또는 생성자 정의 블록 안에 위치해서는 안 된다.

6. 선언

6.1. 한 줄당 선언문의 수

한 줄에 하나의 선언문을 쓰는 것이 주석문 쓰는 것을 쉽게 해주기 때문에 한 줄에 하나의 선언문을 쓰는 것이 좋다. 다시 말해서, 

   1 int level; // indentation level
   2 int size;  // size of table
   3

위와 같이 쓰는 것이 아래와 같이 쓰는 것보다 좋다. 

   1 int level, size;

같은 줄에 서로 다른 타입을 선언하면 안 된다. 예를 들어 : 

   1  int foo,  fooarray[]; //WRONG!
   2

노트 : 위의 예제는 타입과 변수 이름사이에 하나의 space를 두었다. 또 다른 사용 가능한 방법은 탭을 사용하는 것이다. 예를 들어 : 

   1 int         level;                // indentation level
   2 int         size;                 // size of table
   3 Object   currentEntry;              // currently selected table entry
   4

6.2. 초기화

지역 변수의 경우 그것들이 선언될 때 초기화 되는 것이 좋다. 변수가 선언될 때 초기화 되지 않는 단 한가지 경우는 변수의 초기화 값이 처음에 발생하는 어떤 계산에 의해서 결정되는 경우이다.

6.3. 배치

선언은 블록의 시작에 위치해야 한다.(블록은 중 괄호 “{“ 과 “}”로 둘러 싸인 코드이다.) 변수들을 처음 사용할 때까지 변수의 선언을 미루지 말아라 ; 이러한 경우 부주의한 프로그래머를 혼돈시킬 수 있고, 범위 내에서만 변수를 가지는 것을 방해할 수 있다. 

void myMethod() {
    int int1 = 0;         // 메서드 블록의 시작

    if (condition) {
        int int2 = 0;     // “if” 블록의 시작
        ...
    }
}

이러한 원칙 중 단 하나의 예외는 자바에서 for 문장에서 선언될 수 있는 for 루프에서의 인덱스이다 : 

for (int i = 0; i < maxLoops; i++) { ... }

더 높은 레벨에서의 선언을 숨기기 위해서 블록의 처음에서 선언하는 것은 피해야 한다. 예를 들어, 블록 안의 블록에서 같은 변수 이름을 선언하지 말아라 : 

int count;
...
myMethod() {
    if (condition) {
        int count = 0;     // 사용하지 말 것!
        ...
    }
    ...
}

6.4. 클래스와 인터페이스의 선언

자바 클래스와 인터페이스를 선언할 때, 다음과 같은 포맷의 원칙을 따라야 한다 :

7. 문장

7.1. 간단한 문장

각각의 줄에는 최대한 하나의 문장만 사용하도록 한다. 예를 들어 : 

argv++;       // Correct
argc--;       // Correct
argv++; argc--;       // AVOID!

7.2. 복합 문장

복합 문장은 중괄호 “{ 문장들 }”로 둘러싸여진 문장들의 리스트를 포함하는 문장이다. 예를 위해 다음 절을 보아라.

7.3. return 문장

값을 가지는 return 문장은 어떤 방법으로 더 확실한 return 값을 가지는 경우를 제외하고는 괄호를 사용해서는 안 된다. 예를 들어 : 

return;

return myDisk.size();

return (size ? size : defaultSize);

7.4. if, if-else, if else-if else 문장

문장의 if-else는 다음과 같은 형태를 가져야 한다 : 

if (condition) {
    statements;
}

if (condition) {
    statements;
} else {
    statements;
}

if (condition) {
    statements;
} else if (condition) {
    statements;
} else {
    statements;
}

노트 : if 문장은 항상 중괄호를 사용한다. 다음과 같이 에러가 발생할 수 있는 형태는 피해야 한다 : 

if (condition) // 이렇게 중괄호 {}를 생략해서 사용하지 말아라!
    statement;

7.5. for 문장

for 문장은 다음과 같은 형태로 사용해야 한다 : 

for (initialization; condition; update) {
    statements;
}

빈 for 문장(모든 작업이 initialization, condition, update절에서 완료되는)은 다음과 같은 형태를 가져야 한다 : 

for (initialization; condition; update);

for 문장의 initialization또는 update절에서 콤마 연산자를 사용할 때에는, 세 개의 변수 이상을 사용하는 복잡성은 피해야 한다. 만약 필요하다면, for루프 전에 문장을 분리시켜 사용(initialization절의 경우)하거나 루프의 마지막에 문장을 분리시켜 사용(update절의 경우)한다.

7.6. while 문장

while문장은 다음과 같은 형태를 가진다 : 

while (condition) {
    statements;
}

빈 while문장은 다음과 같은 형태를 가진다 : 

while (condition);

7.7. do-while 문장

do-while문장은 다음과 같은 형태를 가진다 : 

do {
    statements;
} while (condition);

7.8. switch 문장

switch문장은 다음과 같은 형태를 가진다 : 

switch (condition) {
case ABC:
    statements;
    /* 계속 진행한다. */

case DEF:
    statements;
    break;

case XYZ:
    statements;
    break;

default:
    statements;
    break;
}

모든 경우를 수행해야 하는 경우 break 문장을 포함하지 않는다. 이러한 경우는 앞의 예제 코드의 첫번째 case에서 볼 수 있다.

모든 switch문장은 default case를 포함해야 한다. Default case에서 break는 중복적이지만, 이후에 또 다른 case가 추가되어질 경우 에러를 방지할 수 있다.

7.9. try-catch 문장

try-catch문장은 다음과 같은 형태를 가진다 : 

try {
    statements;
} catch (ExceptionClass e) {
    statements;
}

try-catch문장은 try 블록이 성공적으로 완료되든 안되든 개의치 않고 실행되는 부분을 추가하기 위해서 finally을 가질 수 있다. 

try {
    statements;
} catch (ExceptionClass e) {
    statements;
} finally {
    statements;
}

8. 공백

8.1. 빈 줄

빈 줄은 논리적으로 관계된 코드의 부분을 구분하기 때문에 가독성을 향상시킨다.
두개의 빈 줄은 항상 다음과 같은 환경에서 사용되어져야 한다 :

CategoryJava

ZbmonWiki: JavaCodeConventions (2009-12-12 13:34:13에 zbmon가(이) 마지막으로 수정)