컨벤션 및 규칙
- Java 컨벤션 : 캠퍼스 핵데이 Java 코딩 컨벤션
- Git commit 컨벤션 : AngularJS Commit Message Conventions
- feat : 기능 추가
- fix : 버그 수정
- hotfix : 치명적인 버그 수정
- docs : 문서 수정
- style : 코드 포맷팅, 세미콜론 누락 등 코드 변경이 없는 경우
- rename : 파일명, 디렉토리 변경
- refactor : 코드 리팩토링
- test : 테스트 코드 추가
- chore : 빌드 업무 수정, 패키지 매니지 수정 등
- asset : 이미지 소스 추가
- test : 테스트 관련
- !BreakingChange : 커다란 API의 변경
- conf : 설정 파일 관련
- 가로 format 맞추기 : 120자 정도로 행 길이를 제한한다.
객체지향 생황 체조 원칙 지키기
- 1: 한 메서드에 오직 한 단계의 들여쓰기만 한다.
- 2: else 예약어를 쓰지 않는다.
- 3: 모든 원시값과 문자열을 포장한다.
- 4: 한 줄에 점을 하나만 찍는다.
- 5: 줄여쓰지 않는다(축약 금지).
- 6: 모든 엔티티를 작게 유지한다.
- 7: 3개 이상의 인스턴스 변수를 가진 클래스를 쓰지 않는다.
- 8: 일급 콜렉션을 쓴다.
함수
- 작게 만들어라.
- 한 가지 작업만 수행하게 해라.
- 함수 당 추상화 수준은 하나로
- 함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장이 동일한 추상화 수준에 있어야 한다.
- 코드는 위에서 아래로 이야기처럼 일해야 좋다.
- 서술적인 이름을 사용하라