코딩 컨벤션

내가 코드를 작성할 때 신경쓰는 코딩 규약들을 정리해본다.

소유권

  • 객체의 소유 주체는 (생성과 소멸의 관리 주체는) 하나로 규정한다.
  • 객체의 생성,소멸 스레드도 하나로 규정한다.
  • 다른 클래스에서 호출되어야만 하는 메소드를 만들지 말라.
  • Has a 관계가 명확하다면, 이 관계를 혼란 시킬 수 있는 메소드는 절대 만들지 마라.

진입점

  • 진입 점은 명확하게. 한곳으로 관리하자. 
  • 만약 다양한 진입 점이 있을 수 밖에 없다면, 다른 각각의 진입 점에서 왔음을 알 수 있게 하라.

중복

  • 중복을 허용하지 말라.

단일 규칙

  • 두 가지 이상의 규칙을 허용하지 말라. 새로운 규칙을 도입하고 싶다면, 기존 규칙대로 작성된 전부를 고쳐라.
  • 두 가지 이상의 규율이 존재하는 것은, 코드 작성/분석 등 모든 과정에서 해가 된다.

전치 검사, 후치 검사

  • 메소드는 정상적으로 실행되기 위한 선결 조건에 대한 검사를 해야 한다.
  • 메소드는 정상적으로 실행되었을 때의 기대 값을 충족 시키는지 검사해야 한다.

호출 주체

  • 누가 호출해도 문제가 없는 메소드만 외부로 개방하라.
  • 만약 특정 클래스에서만 호출해야 정상 동작한다면, 잘못된 설계이고, 잘못된 사용법을 제공하는 것이다.

호출 순서

  • 호출 순서에 영향을 주는 코드는 지양하라.
  • 피치 못할 사정으로 함수의 호출 순서가 일정해야만 한다면, 정해진 호출순서대로 실행하는 상위 함수를 만들고, 내부를 숨겨라.

Comments

comments powered by Disqus