Skip to content

Convention

choiyoungjin edited this page May 16, 2022 · 2 revisions

Code Convention

1. 기본

커밋 전 Reformat Code 적용

2. 네이밍 규칙

2.1. 변수명

  • 일반 변수 : camelCase
  • 상수 변수 : UPPER_SNAKE_CASE
  • Boolean 변수 : is, has 접두사 사용
  • 단, 복수 표현 지킬 것
  • 명사 형태 로 작성

2.2. 함수명

  • camelCase
  • 동사로 시작하는 동사구 형태로 작성
  • 무슨 기능을 하는 함수인지 명확히 알아볼 수 있도록 짓기

2.3. 파일명

  • 코틀린 파일 : UpperCamelCase 적용

3. 주석 작성 규칙

구현 예정인 경우 : // TODO 로 표기

4. xml 작성 규칙

  • themes.xml : 반복되는 스타일을 정의해서 사용
  • id 속성 : snake_case 적용
    • textView → tv_
    • editText → et_
    • imageView → iv_
    • button → btn_
    • layout → layout_
  • strings.xml name 속성
    • 공통으로 사용되는 것은 접두사 필요 없다!
    • 뷰에서 사용되는 스트링은 뷰의 이름을 접두사로 사용

Git Convention

  1. Commit [type] 한글로 한줄 설명
type description
feat 프로세스 및 UI 구현
mod 코드 수정
refactor 리팩토링
Clone this wiki locally