작명

• 이상한 축약형 쓰지 말기

  int TST = 1
  int timeSinceCreation = 1 // 만들고 나서의 시간
  

• 접두어 넣지 말기

  int gCount = 1;
  int gameCount = 1;
  

• 잘 안쓰는 단어 넣지 말기

  void whackProcess(){} // whack = 구타
  void killProcess(){}
  

• 발음하기 쉬운 이름/검색하기 쉬운 이름 쓰기

• 함수나 메서드는 동사를 넣기

  void activeAccount(){}
  void getActiveAccount(){}
  

• 클래스 이름과 객체 이름은 명사나 명사구

  Customer, WikiPage, Account, AddressParser
  

• 인터페이스 클래스와 구현 클래스

  public class ShapeFactoryImpl implements ShapeFactory {
  }
  

Functions

• 함수는 무조건 하나의 일만 하기
• 함수가 너무 길면 안 좋다. 가능한 짧게 한 3~4줄 정도
• 매개 변수 많아서 좋을 거 없음

하지만! 가독성을 고려해 적당히 반영할 것!

주석

코드에 주석을 달지마라(?)

• 주석은 거짓말을 할 수 있다.
• Spring 처럼 틀이 정해져 있는 경우는 코드의 의도를 파악하기 어렵지 않지만 자유도가 높은 프레임워크의 경우 코드의 의도를 파악하기 어렵다.

function getLastLastWeekRegisteredPeopleNameOrder(){}
//이럴거면 그냥 주석으로 설명하는게 낫다.

좋은 주석의 조건