Great Architect & Artist

7. 문서화 (javadoc) 

7.1 서식(formatting)

1. 일반 서식 (General form)

Javadoc 블록의 기본적인 형식은 다음 예제에서 보는 것과 같습니다.

/**

 * Multiple lines of Javadoc text are written here,

 * wrapped normally...

 */

public int method(String p1) { ... }

또는 다음과 같은 하나의 라인으로 작성할 수 있습니다.

/** An especially short bit of Javadoc. */

기본적인 형식(basic form)은 항상 허용됩니다. Javadoc 블록 전체(주석 표시 포함)가 하나의 라인으로 작성할 수 있는 경우는 한 줄 형식으로 대체될 수 있습니다. @return과 같은 블록 태그가 없는 경우에만 해당됨을 유의하세요.

2. 단락(Paragraphs)

정렬된 선행 별표(aligned leading asterisk:’*’)만 포함하고 있는 하나의 빈 줄은 단락 사이와 블록 태그 그룹이 있을 경우 태그 그룹 앞에 나옵니다. 첫번째 단락을 제외한 각 단락은 첫번째 단어 바로 앞에 <p> 태그가 있고, 뒤에는 공백이 없습니다.

3. 블록 태그(Block tags)

코드에 사용하는 표준 “블록 태그(block tags)”는 @param, @return, @throws, @deprecated 순서로 사용되며, 이 4가지 유형은 설명이 비어 있으면 안 됩니다. 블록 태그가 한 줄에 맞지 않으면 @위치에서 4개 이상의 스페이스로 들여쓰기를 합니다.

7.2 요약 단편(the summary fragment)

각 Javadoc 블록은 간단한 요약 단편으로 시작합니다. 이 단편적인 요약은 매우 중요합니다.  클래스나 메서드 인덱스처럼 특별한 컨텍스트(context)에서 나타나는 텍스트의 유일한 부분입니다.

이 단편은 완전한 문장이 아니라 명사구나 동사 구절입니다. A {@code Foo}처럼 시작하지도 않고, “This method returns…”로 시작하지도 않고, “Save the rcord..”와 같은 완전한 명령형 문장의 형태로 시작하지도 않습니다. 하지만, 요약 단편에는 완전한 문장인 것처럼 대문자와 구두점이 있습니다.

Tip : 일반적으로 /** @return the customer ID */와 같이 Javadoc을 작성하는 실수를 하게 됩니다. 이것은 잘못된 것입니다. /** Returns the customer ID */처럼 변경해야 합니다.

7.3 Javadoc 사용처(where javadoc is used)

최소한, Javadoc은 모든 public class와 그 클래스에 있는 public, protected 멤버에 관해 존재하지만, 아래 언급된 몇 가지 예외가 있습니다.

아래 3번 Non-required Javadoc에 설명되어 있는 것처럼, 추가적인 Javadoc 컨텐츠가 있을 수 있습니다.

1. 예외(Exception) : 자체 서술적인 메서드 (self-explanatory methods)

getFoo와 같이 “단순하고 분명한(simple, obvious)” 메서드에 대해서 Javadoc을 작성하는 것은 선택 사항입니다. 이 경우처럼, “Returns the foo”라고 말하는 것 이외 아무것도 말할 가치가 없는 경우도 있습니다.

중요(important) : 일반적으로 독자가 알 필요가 있는 관련 정보를 생략하는 것을 정당화하기 위해 위에 언급된 예외를 적용하는 것은 적합하지 않습니다. 예를 들어, getCanonicalName의 메서드의 경우, 일반 독자가 “표준 이름(canonical name)”이라는 용어가 무엇을 의미하는지 모를 경우 해당 Javadoc 문서(단지 /** Returns the canonical name. */만을 말하고자 하는 이유일지라도)를 생략하면 안 됩니다.

2. 예외(Exception) : 재정의(override)

상위 유형(supertype) 메서드를 재정의하는 경우에는 항상 Javadoc이 존재하는 것은 아닙니다.

3. 불필요한 경우 (Non-required Javadoc)

다른 클래스와 멤버의 경우, 필요에 따라 Javadoc이 있습니다.

구현 주석(implementation comments)이 클래스나 멤버 전체의 목적이나 동작에 대해 정의하는데 사용되는 경우, 해당 주석은 Javadoc으로 작성될 수 있습니다. (/** 사용)

불필요한 경우의  Javadoc(non-required javadoc)은 위에서 정리한 단락(Paragraphs)이나 블록 태그(Block tags), 요약 단편(Summary fragments)의 형식을 따르도록 엄격하게 요구되지는 않지만, 될 수 있으면 정해진 형식을 따르기를 권고합니다.  

6. 프로그래밍 실습 (Programming practices) 

6.1 @Override: always used

메서드(method)는 합법적일 때마다 @Override 어노테이션(annotation)으로 표시됩니다. 여기에는 슈퍼클래스(super class)의 메서드를 재정의(override)하는 클래스 메서드, 슈퍼인터페이스(super interface)의 메서드를 재지정(respecifying)하는 인터페이스 메서드를 포함합니다.

예외(Exception) : @Deprecared일 경우에는 @Override를 생략할 수 있습니다.

6.2 Caught exceptions: not ignored (예외가 발생했을 때, 무시하지 말 것)

아래 언급된 경우를 제외하고, 예외가 발생했을 때(caught exception) 아무런 응답을 하지 않는 것은 매우 드문 경우입니다. (일반적으로 응답(response)은 기록해야 합니다. 만약 기록이 불가능(“impossible”)하다고 여겨지는 경우에는 AssertionError를 다시 발생(rethrow)시킵니다.)

Catch 블록에서 아무 조치도 취하지 않는 것이 정말 적합할 경우, 정당화되는 이유가 코멘트로 설명되어 있습니다.

try {

  int i = Integer.parseInt(response);

  return handleNumericResponse(i);

} catch (NumberFormatException ok) {

  // it's not numeric; that's fine, just continue

}

return handleTextResponse(response);

예외(Exception) : 테스트에서 발견된 예외는 이름이 기대되는 예외일 경우, 주석없이 무시될 수 있습니다. 다음 코드는 예상되는 예외를 확인하기 위한 아주 일반적인 관용구이기 때문에 주석이 필요하지 않습니다.

try {

  emptyStack.pop();

  fail();

} catch (NoSuchElementException expected) {

}

6.3 정적 멤버(static members): 클래스를 사용하여 한정(qualified using class)

정적 클래스 멤버(static class member)에 대한 참조(reference)가 규정되어야 하는 경우, 클래스 유형(class type)의 참조나 표현식이 아니라 해당 클래스 이름으로 규정되어야 합니다.

Foo aFoo = ...;

Foo.aStaticMethod(); // good

aFoo.aStaticMethod(); // bad

somethingThatYieldsAFoo().aStaticMethod(); // very bad

6.4 종료자(finalizers) : 사용하지 않음(not used)

Object.finalize를 재정의(override)하는 것은 극히 드문 경우입니다. 사용하지 않습니다.

Tip : 사용하지 마십시오. 반드시 사용해야 할 것 같으면, 먼저 Effective Java 항목 7 “종료자 피하기(Avoid Finalizers)”를 매우 주의 깊에 읽고 이해한 다음에 사용하지 마세요.

5. 네이밍(naming)

5.1 모든 식별자에 적용되는 공통 규칙(rules common to all identifiers)

식별자(identifier)는 ASCII 문자와 숫자만 사용하며, 아래에 언급된 소수의 경우에만 밑줄(underscore)를 사용합니다. 따라서, 각 유효한 식별자 이름은 정규식(regular expression) \w+ 와 일치합니다.

(구글 스타일에서는) 특수한 접두사나 접미사를 사용하지 않습니다. 예를 들어, name_, mName, s_name, kName과 같은 이름은 (구글) 스타일이 아닙니다.

5.2 식별자 유형별 규칙(rules by identifier type)

1. 패키지 명 (Package names)

패키지 명은 모두 소문자이며, 연속된 단어는 간단하게 서로 연결됩니다. (밑줄 없음) 예를 들어, com.example.deepSpace나 com.example.deep_space가 아니라 com.example.deepspace로 패키지명을 작성합니다.

2. 클래스 명 (Class names)

클래스 이름은 UpperCamelCase(단어가 시작되는 맨 앞 한글자를 대문자로 작성하는 유형)로 작성합니다. 클래스 이름은 일반적으로 명사나 명사구입니다. 예를 들어, Character 나 ImmutableList와 같습니다. 인터페이스(Interface) 이름은 명사나 명사구(예를 들면, List)일 수도 있지만, 때로 형용사나 형용사구가 될 수도 있습니다. (예 : Readable)

어노테이션 유형의 명명(naming annotation type)에 대해서는 특정 규칙이나 잘 정립된(well-established) 규정(convention)은 없습니다.

테스트 클래스(Test class)는 테스트 중인 클래스 이름으로 시작하여 Test로 끝나는 이름으로 명명합니다. 예 : HashTest 또는 HashIntegrationTest

3. 메서드 명 (Method names)

메서드 이름은 lowerCamelCase(맨 앞 한글자는 소문자로, 다음 단어의 맨 앞 한글자는 대문자로 작성하는 유형)로 작성합니다. 메서드 이름은 일반적으로 동시 또는 동사구로 작성합니다. 예를 들면 다음과 같습니다. 

Ex) sendMessage 또는 stop

밑줄은 lowerCamelCase로 작성된 각 컴포넌트와 이름을 논리적으로 구분하기 위해 JUnit 테스트 메서드에 나타날 수 있습니다. 한가지 일반적인 패턴은 <methodUnderTest>_<state>의 형태입니다. (예: pop_emptyStack). 테스트 메서드의 이름을 지정하는 단 한가지의 완벽한 방법은 없습니다.

4. 상수 명 (Constant names)

상수 명은 CONSTANT_CASE와 같은 유형을 사용합니다. 상수 명은 모두 대문자이며, 각 단어는 하나의 밑줄로 다음 단어와 구분됩니다. 하지만, 정확하게 상수가 무엇일까요?

상수는 내용이 변경되지 않고(immutable), 메서드에 부작용(side effect)이 전혀 없는 static final field 입니다. 여기에는 기본형(primitives), 스트링형(Strings), 불변 유형(immutable type), 불변 유형의 불변 컬렉션(immutable collection)이 포함됩니다. 만약 인스턴스의 관찰 가능한 상태가 변경될 수 있다면, 그것은 상수가 아닙니다. 객체를 변경하지 않으려는 의도만으로는 충분하지 않습니다.

예를 들면 다음과 같습니다.

// Constants

static final int NUMBER = 5;

static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");

static final ImmutableMap<String, Integer> AGES = ImmutableMap.of("Ed", 35, "Ann", 32);

static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutable

static final SomeMutableType[] EMPTY_ARRAY = {};

enum SomeEnum { ENUM_CONSTANT }

// Not constants

static String nonFinal = "non-final";

final String nonStatic = "non-static";

static final Set<String> mutableCollection = new HashSet<String>();

static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);

static final ImmutableMap<String, SomeMutableType> mutableValues =

    ImmutableMap.of("Ed", mutableInstance, "Ann", mutableInstance2);

static final Logger logger = Logger.getLogger(MyClass.getName());

static final String[] nonEmptyArray = {"these", "can", "change"};

이러한 이름은 일반적으로 명사나 명사구입니다.

5. 비상수 필드 명 (Non-constant field names)

상수가 아닌 필드 명(non-constant field name)은 (static이든 아니든) lowerCamelCase로 작성됩니다.

이러한 이름은 일반적으로 명사 또는 명사구로 작성됩니다.

예를 들면 다음과 같습니다.

Ex) computedValues 또는 index

6. 파라미터 명 (Parameter names)

파라미터(매개변수 : parameter) 명은 lowerCamelCase로 작성됩니다.

Public 메서드에서 단일 문자 파라미터 이름은 피해야 합니다.

(다른 사람이 변수 명을 이해할 수 없습니다.)

7. 지역 변수 명 (Local variable names)

지역 변수 명은 lowerCamelCase로 작성합니다. final이나 immutable의 경우에도, 지역 변수는 상수로 간주하지 않으며 상수 스타일로 코드를 작성하면 안 됩니다.

8. 유형 변수 명 (Type variable names)

각 유형 변수 명은 다음 2가지 스타일 중 하나로 작성합니다.

 - 단일 대문자, 선택적으로 뒤에 단일 숫자 추가 (ex. E, T, X, T2)

 - 클래스에 사용되는 형태의 이름 뒤에 대문자 T (ex. RequestT, FooBarT)

5.3 카멜 케이스(camel case : defined)

“IPv6”이나 “iOS”와 같이 두문자어나 특이한 구조가 있는 경우처럼 영어 구문을 Camel Case(영어 대소문자로 변환)로 변환하는 합리적인 방법이 한가지 이상 있습니다. 예측 가능성을 개선하기 위해서 Google Style 표준에서는 다음과 같은 (거의) 결정적인 스키마를 지정합니다.

산문형 이름으로 시작 : 

1. 어구를 ASCII로 변환하고 Apostrophe(‘)를 제거하세요. 예를 들어, “Müller's algorithm”는 “Muellers algorithm”으로 변환됩니다.

2. 이 결과를 공백과 나머지 구두점(punctuation)으로 (일반적으로 hypen: ‘-‘)으로 분할하여 나눕니다.

• 권장(Recommended) : 이미 전통적인 Camel Case를 일반적으로 사용하고 있다면, 구성요소로 분할합니다. (예 : AdWord는 ad word로 분할됨) 하지만, “iOS”와 같은 경우는 Camel Case가 아니기 때문에 어떤 규칙에도 위배됩니다. 따라서 이 권장사항은 적용되지 않습니다.

3. 모든 항목(약어 포함)을 소문자로 만든 다음, 첫번째 문자만 대문자로 합니다.

• … 각 단어를 Upper Camel Case로 사용하거나, (각 단어의 첫글자를 대문자로)
• … 각 단어의 첫번째 글자를 제외하고,  Lower Camel Case로 사용합니다. (첫 단어의 첫글자 소문자, 다른 단어의 첫글자는 대문자로)

4. 끝으로, 모든 단어를 단일 식별자로 결합합니다.

원래 단어의 대소문자는 거의 대부분 무시되는 것에 유의하세요.

예:

YoutubeImporter* : 수용 가능하지만, 권장하지 않습니다.

Note : 일부단어는 영어에서 모호하게 ‘-‘으로 연결됩니다. : 예를 들어, “nonempty”와 “non-empty”는 모두 정확하기 때문에 checkNonempty, checkNonEmpty도 모두 정확한 표현입니다.