스타일 / 네이밍 / 주석

코딩 스타일

줄바꿈과 들여쓰기를 적절히 쓰자.

알아보기 힘든 긴 식은 괄호를 이용해 우선순위를 잘 나타내주자.

공백을 적절히 사용하자.

한 행에 모든 것을 넣지 말자.

-> 가독성을 높이고 일관성을 가지자

네이밍

정확한 철자를 사용하고 생략된 단어를 쓰지 말자.

컬렉션 이름은 복수형이 좋다.

필드나 속성명은 명사. 메서드 이름은 동사를 이용해 무엇을 나타내는지. 무슨 동작인지를 설명하는 이름을 짓자.

bool형은 Is, Can, Has를 주로 사용하여 명확한 이름을 짓자. emptyFlag보다는 IsEmpty로

bool형에 부정적인 이름을 붙이지 말자. if (!notDone) 같이 부정이 중첩되면 이해하기가 힘들다.

-> 그것이 나타내는 것을 잘 설명하는 이름을 짓자

주석

당연한 주석은 쓰지말자. (0으로 초기화, 무한반복 등..)

클래스나 메서드 주석은 개요를 쓰되 너무 자세하게는 적지 말자.

코드를 읽어 알 수 없는 정보를 주석에 쓴다. (무슨 버그가 있어서 이렇게 작성했다.)

잘못된 코드에 주석을 쓰기보다 코드를 수정하여 주석을 안 쓸 수 있게하자.

주석처리한 코드는 웬만하면 방치하지 않는다.

-> 주석은 최소한으로 필요한 부분만