Code Convention - Coffee-Street/Document GitHub Wiki

디렉토리 및 파일 생성 규칙

디렉토리

• 소문자와 언더바(_)로만 표기한다.

프로젝트 파일

기본 구성 규칙

• 별도의 프로젝트로 나누지 않고, 프로젝트 내 디렉토리 구조로 구성한다.
  • 앱 개발 중 외부 모듈을 따로 나눌일이 별로 없을 것이라 판단되기 때문. 추후 프로젝트 분리 필요성이 있으면 재논의.

프로젝트 파일 네이밍 규칙

• 파스칼(Pascal, Upper Camel) 형식으로 생성한다.
• 띄어쓰기는 허용하지 않는다.

코드 스타일

• dart의 추천 코드 스타일을 따른다.

기본 작성 스타일

괄호

K&R 형식을 사용한다.

들여쓰기

• 들여쓰기 : 2 space를 사용한다. (Tab 사용하지 않음.)

주석

• 자유롭게, 단 다른 개발자를 위해 보기 좋게 작성한다.
• TODO를 잘 활용하면 좋다.

네이밍 규칙

클래스

• 파크칼(Upper Camel) 형식을 사용한다.
• 테스트 클래스는 뒤에 Test를 붙인다.

메소드

• 파크칼(Upper Camel) 형식을 사용한다.
• 동사+명사 형식으로 작성한다. Ex) return DoHomeWork();
• 클래스 안 멤버 메소드는 앞에 언더바(_)를 붙여 작성한다.

변수

• 카멜(Lower Camel) 형식을 따른다.
• 클래스 안 멤버 변수는 앞에 앞에 언더바(_)

참고 자료

• Effective Dart: Usage : Booleans
  • optional pointer 가 null exception 인 경우 true false로 변환