03. formatting - 01 :: 2021/11/17 16:45
개발자를 위한
Java Programming Style Guide (ref. Google style guide)
4. 서식(Formatting)
Terminology Note(용어 참고) : 블록과 유사한 구성(block-like construct)은 클래스(class), 메서드(method)나 생성자(constructor)의 본문(body)를 나타냅니다. 단, 모든 배열 초기자(array initializer)는 선택적으로 블록과 유사한 구성으로 작성될 수 있습니다.
4.1 중괄호(braces)
- 중괄호를 선택적으로 사용하는 경우
중괄호는 본문이 비어 있거나, 단일 구문만 포함하고 있는 경우에도, if, else, for, do, while 문과 함께 사용됩니다.
- 비어 있지 않은 블록 (K&R Style)
중괄호는 비어 있지 않은 블록이나 블록과 유사한 구성에K&R Style(Kernighan and Ritchie Style) (“이집트 대괄호”)를 따릅니다.
- 여는 중괄호(opening brace) 전에는 줄바꾸지 않습니다(No line break).
- 여는 중괄호 다음에는 줄바꿈합니다(Line break).
- 닫는 중괄호(closing brace) 전에 줄바꿈합니다.
- 만약 구문이 종료되거나, 메서드나 생성자, 명명된 클래스의 본문이 종료되는 경우, 닫는 중괄호 다음에 줄바꿈합니다. 예를 들어, else나 쉼표(comma)가 뒤에 오는 경우에는 닫는 중괄호 다음에 줄 바꿈을 하지 않습니다.
<실제 사용 예>
return () -> {
while (condition()) {
method();
}
};
return new MyClass() {
@Override public void method() {
if (condition()) {
try {
something();
} catch (ProblemException e) {
recover();
}
} else if (otherCondition()) {
somethingElse();
} else {
lastThing();
}
}
};
다만, 열거형 클래스(Enum Class)에는 몇 가지 예외가 있습니다.
- 빈 블록(Empty blocks) : 잘 활용하면 간결해질 수 있음
빈 블록이나 블록과 유사한 구성을 K&R Style(Kernighan and Ritchie Style)로 작성할 수 있습니다. 다중 블록 구문(여러 블록을 직접적으로 포함하는 if/else, try/catch/finally 구문처럼)의 일부가 아닌 한, 중괄호({}) 사이에 문자나 줄바꿈 없이 중괄호 오픈 후, 바로 닫을 수 있습니다.
<실제 사용 예>
// This is acceptable
void doNothing() {}
// This is equally acceptable
void doNothingElse() {
}
// This is not acceptable: No concise empty blocks in a multi-block statement
try {
doSomething();
} catch (Exception e) {}
4.2 블록 들여쓰기(block indentation) : +2 스페이스(spaces)
새로운 블록이나 블록과 유사한 구성을 작성할 때마다 들여쓰기는 2개의 스페이스만큼 늘어납니다. 블록이 끝날 때, 들여쓰기는 바로 이전 들여쓰기 수준으로 돌아갑니다. 들여쓰기는 코드와 주석 모두에 적용됩니다.
4.3 한 줄에 하나의 구문(one statement per line)
각 구문의 끝에서는 줄바꿈을 해야 합니다.
4.4 열 제한(column limit) : 100
Java 코드의 열 제한은 100글자입니다. “글자”는 유니코드를 의미합니다. 아래 명시된 경우를 제외하면, 이 제한 조건을 초과하는 모든 라인은 줄바꿈을 해야 합니다.
Note : 각 유니코드는 표시되는 너비가 더 크거나 더 작더라도 한 글자로 계산됩니다. 예를 들어, 전각 문자를 사용하는 경우, 이 규칙에서 엄격하게 요구하는 것보다 먼저 줄바꿈하도록 선택할 수 있습니다. (전각문자 : 일반적인 영문자의 고정 폭의 두 배 정도의 폭을 가지는 문자)
<예외>
- 열 제한 규칙을 준수할 수 없는 경우(예: Javadoc의 긴 URL이나 긴 JSNI 메서드 참조)
- 패키지 구문(package statement) 및 임포트 구문(import statements)
- 쉘(shell)에 복사 후 붙여넣기(copy & paste)할 수 있는 주석 내 명령어 라인(command line)
4.5 라인 변경(line-wrapping)
Terminology Note(용어집): 한 줄로 작성할 수 있는 코드가 여러 줄로 나뉘는 경우, 이러한 활동을 라인 변경이라고 합니다.
모든 상황에서 어떻게 라인을 변경 해야 하는지 정확하게 보여주는 포괄적이고 결정적인 공식은 없습니다. 다만, 자주 동일한 코드 조각을 라인 변경하는 몇 가지 적절한 방법이 있을 뿐입니다.
Note : 라인 변경하는 일반적인 이유는 열 제한(column limit)을 넘어가는 경우를 방지하기 위한 것입니다. 하지만, 열 제한을 만족시키는 코드라도 작성자의 재량에 따라 라인을 변경할 수 있습니다.
Tip : 메서드(method)나 지역 변수(local variable)를 추출하면 라인 변경없이 문제를 해결할 수 있습니다.
- 어디에서 라인 변경할 것인가
라인 변경의 주요 지시문(prime directive) : 더 높은 구문 수준에서 줄바꿈하는 것을 선호
1) 비 할당된 연산자(non-assignment operator)에서 줄이 끊어질 경우, 기호(symbol)앞에서 라인을 변경합니다. (C++이나 JavaScript와 같은 다른 언어의 Style과 동일하지 않습니다.)
- 다음 “연산자와 유사한(operator-like)” 기호에도 적용됩니다.
- 점 구분자(dot separator: ‘.’)
- 메서드(method) 참조를 위한 2개의 콜론(::)
- 타입 바운드(Type Bound) 내 &(<T extends Foo & Bar>)
- Catch 블록 내 Pipe(catch (FooException | BarException e))
2) 할당된 연산자(assignment operator)에서 줄이 끊어질 경우, 일반적으로 기호(symbol)뒤에서 라인 변경하지만 어느 쪽이든 허용합니다.
- 더 향상된 for 구문(“foreach”)의 “할당 연산자와 유사한(assignment-operator-like)” 콜론에도 적용됩니다.
3) 메서드(method)나 생성자(constructor) 이름 바로 다음에 여는 괄호(()를 작성합니다.
4) 쉼표(,)는 앞에 오는 토큰 바로 다음에 작성합니다.
5) 람다의 본문이 중괄호가 없는 단일 표현으로 이루어진 경우 화살표 바로 다음에 줄이 끊어질 수 있다는 것을 제외하면, 람다의 화살표 옆에서 줄이 끊어지지 않아야 합니다.
<실제 사용 예>
- 일반적인 람다
MyLambda<String, Long, Object> lambda =
(String label, Long value, Object obj) -> {
...
};
- 중괄호가 없는 단일 표현으로 이루어진 람다
Predicate<String> predicate = str ->
longExpressionInvolving(str);
Note : 라인 변경의 주요 목표는 코드를 명확하게 하는데 있습니다. 가장 짧은 코드를 작성하기 위한 것은 아닙니다.
- 연속 줄 들여쓰기(Indent continuation lines) : 최소 +4 스페이스 (at least +4 spaces)
라인 변경할 때 첫번째 줄 이후 각 줄(연속하는 줄 포함)은 원래에서 최소한 +4 스페이스로 들여쓰기 합니다.
연속 행이 여러 개인 경우 원하는 대로 들여쓰기를 +4 이상으로 변경할 수 있습니다. 일반적으로 2개의 연속 행일 경우에는 구문적으로 병렬 요소(parallel element)일 경우에만 동일한 들여쓰기 수준을 사용합니다.
이후에 정리된 수평 정렬(Horizontal Alignment)에서는 특정 토큰을 이전 라인과 정렬하기 위해서 다양한 숫자의 스페이스를 사용하는, 권장하지 않는 실제 사례들을 다룹니다.