코딩할 때 고민하는 많은 것들은 가독성을 높이기 위해서이다. 한 번 작성한 코드를 여러 번 읽게 되기 때문이다. 아래 내용의 대부분은 가독성을 높이기 위함이다.

Variable Naming Convention

• 읽는 사람 입장에서 불분명한 축약형은 지양한다.
• 데이터 타입을 명시하지 않는다. 이 컨벤션은 정적타입 언어가 없고 IDE 등을 통해 타입 추론 지원이 어려웠던 시대에나 유용했던 방법이다.
• 알파벳이나 _로 시작한다. (ㅇㅇ한 목적이 있을 때 _로 시작한다.) // TODO: 무슨 목적?

Comment

• 주석은 상위 레벨에서 해당 메서드나 함수가 어떤 동작을 하는지 설명하는 식으로 사용하는 것이 좋음 (많은 라이브러리가 채택하는 방식)
• 선언적인 하위 레벨 주석은 오히려 읽기 어렵게 만듦
• 어떤 언어의 키워드가 어떤 동작을 하는지 등을 설명하는 코드도 X. 코드에는 코드 자체에 대한 설명만 나오는 것이 좋음
• 주석은 업데이트가 잘 안되는 경우가 많아서 완전히 신뢰하지 않는 게 좋음
• 제대로 된 코드를 확정하기 전에 완전 삭제하기는 아까운 코드를 삭제 대신 주석 처리 해가면서 코딩하면 편함

Whitespace

• 완전한 명령들은 각각 한 라인씩 쪼개서 배치하는 게 좋음
• 하나의 명령을 여러 줄로 쪼갤 필요 없음
• 한 줄이 너무 길면 쪼갤 수는 있지만, 합당한 이유가 있을 때 쪼개는 것이 좋음
• 할당 연산자 앞뒤로 공백을 넣어주는 것이 좋음

Indent

• 인덴트를 잘 넣어줘서 해당 코드가 어느 코드 블록에 속하는지 잘 보이게 작성하는 것이 좋음