Skip to content

A. Coding Convention

Lim jun su edited this page Aug 20, 2018 · 3 revisions

JAVA

  1. 테스트 이름은 '메소드명_테스트내용'으로 작성(테스트 내용은 한글로)
    • getPrice_상품 10개 이상시 5% 할인
  2. 메소드명은 동사+명사로 작성
    • addCount
  3. 메소드명에서 단/복수 구분하기
  4. 한줄 코딩 금지 ({} 사용하기)
  5. 노란색 하이라이트 최소한으로 줄이기
  6. access modifier 꼭 달기

Javascript

  1. https://github.com/airbnb/javascript/tree/master/css-in-javascript 참고
  2. Camel case로 작성
  3. Page 별로 최소 하나이상의 파일 만들기 (main.js, 페이지 별로만 쓰는 로직 들어가있는 파일로 분기)
  4. 재활용하는 코드나 로직이 복잡한 코드는 클라스로 분리 (추후 논의)

HTML & CSS

  1. css selector 이름지을 땐 공통부분-세부부분으로 작성
.board-container .board-title-holder .board-title-text
  1. id 사용은 자제 (자손으로 찾기)
  2. css 파일 관리할 때 공통으로 쓰는거랑 페이지나 기능별로 쓰는거 구분
  3. css selector 순서 최대한 상세하게 작성, 같은 부분의 csss는 모아서 작성
.board-container {}
.board-title-holder {}
div.board-title-text {}
  1. html에 스타일 넣기 금지, html에 스크립트 문법 넣는거 금지 (단, 템플릿 파일 로딩 제외)
  2. 페이지별 공통 파일은 페이지명 따라가기. ex) login.html > login.js, login.css

Git Commit

커밋 로그 예시

환경설정: .travis.yml 파일 수정
기능추가: BoardSummary 기능 구현 완료
버그수정: 로그인 interceptor 잘못된 redirect 버그 수정
기능변경: task 움직이는 방법 기능 변경
리뷰반영: 요청사항 반영해서 수정완료