Java Coding Concentions - Oracle 2

1. 주석

■ 구현 주석 : 블록(Block), 한 줄 (Single Line), 꼬리(Trailing), 줄끝(End-of-Line)

블록(Block) 주석 : 파일이나 메서드 앞에서 파일, 메서드, 자료구조, 알고리즘 설명 시 사용, 처음 한 줄은 비우고 두번째 줄 부터 사용

/*

*여기에 블록 주석을 작성한다

*/

 

■ 한줄(single-line) 주석 : 뒤 따라 오는 코드와 동일한 들여쓰기 사용

if (condition) {

 

/* 이 조건을 만족하면 실행한다 */

...

}

 

■ 꼬리(Trailing) 주석 : 짧은 주석의 경우, 실제코드와 구분되도록 충분히 멀리 작성

if ( a == 2) {

return TRUE;            /* 특별한 경우 */

} else {

return isPrime(a);      /* a가 홀수인 경우 */

}

 

■ 줄끝(End-Of-Line) 주석 : //는 한 줄 모두(코드의 일부)를 주석 처리할 때 사용

// if ( bar > 1 ) {

// ...

// }

 

■ 문서화(Documentation) 주석 : 첫 번째 줄은 들여쓰기를 하지 않고 다음 줄은 별표를 수직으로 맞춤

/**

* Example 클래스는 ...

*/

public class Example { ...

 

6. 선언

■ 한 줄당 선언문의 수는 한 개 -> 주석문 추가 용이, 타입과 변수명 사이는 space, Tab 가능

int level; // 들여쓰기 단위      int        level;

int size;  // 테이블 크기         int        size;

 

■ 초기화 : 지역변수 선언 시 초기화 하면 좋음

 

■ 배치 : 선언은 블록의 시작에 위치, 예외 : 반복문의 index는 사용위치에서 선언 가능

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

 

■ 클래스와 인터페이스의 선언 4원칙

1. 메서드 이름과 그 메서드의 파라미터 리스트의 시작인 괄호 " ( " 사이에는 빈 공간 없도록 한다.

2. 여는 중괄호 " { " 는 클래스 / 인터페이스 / 메서드 선언과 동일한 줄의 긑에 사용한다.

3. 닫는 중괄호 " } "는 여는 중괄호 " } " 후에 바로 나와야 하는 null 문의 경우를 제외하고는 , 여는 문장과 동일한 들여쓰기를 하는 새로운 줄에서 사용한다.

4. 메서드들을 구분하기 위해서 각 메서드들 사이에는 한 줄을 비운다.

 

class Sample extends Object {

int ivar1;

int ivar2;

 

sample(int i, int j ) {

ivar1 = i;

ivar2 = j;

}

 

int emptyMethod() {}

....

}

 

2. 문 ( Statement )

 

■ 간단한 문 : 각각의 줄에는 최대한 하나의 문 ( statement ) 만 사용

argv++;   // 올바른 사용법

argc--;     // 올바른 사용법

argv++; argc --;     // X

 

■ 복합문 : if-else문이나 for문 등에 중괄호 " { statements } " 로 둘러싸여진 문들의 리스트를 포함하는 문, 클래스 / 인터페이스 선언 4원칙과 동일

 

■ return 문 : 확실한 return 값을 얻을 수 있는 경우에만 괄호 사용

return;

return myDisk.size();

return ( size ? size : defaultSize );

 

■ if, if-else, if else-if, if문은 항상 중괄호를 사용하고 생략하지 않는다

if ( condition ) {

statements;

}

 

if (condition )

statements;        // X

 

■ do-while문

do {

     statements;

} while ( condition );

 

■ switch문

switch ( condition ) {

case A :

     statements;

     break;

...

}

 

■ try-catch문

try { 

     statements;

} catch (ExceptionClass e {

     statements;

} finally {

...