컨벤션 - 주석

주석은 꼭 필요한 곳에만 달아두는 것이 좋습니다.

비지니스 로직은 항상 변경되기 마련이며, 주석에 로직을 넣는 다면 주석도 관리대상에 포함됩니다. 따라서 프로그램 수정 시 관리해야할 대상이 더욱 넓어짐으로 꼭 필요한 사항이 아니라면 넣지 않는 것이 좋습니다.

1. API는 (///) 사용하여 요약으로 시작할 것 

2. 함수/ 메소드가 어떤 작업을 수행하는지, 어떤 것을 반환하는 지 설명하고, nil과 Void 반환은 생략할 것. 여러줄로 적을 때에는 javaDoc 형식을 사용하지 말 것 (/** … */)

/// 기기 Bluetooth Number로 블루투스 검색을 시작함.
func startScanDevice(btNumber: String)
/// 설명
/// 
/// - Parameters: 파라메터설명
/// - Returns: 리턴설명

3. 주석 사용시, // MARK: 를 사용해서 연관된 코드를 구분 지을 것을 권장. (Obj-C: #pragma mark)

// MARK: LifeCycle
init() { ...}
 
// MARK: Actions
func startButtonDidTap() {... }

4. 아직 개발하지 못한 로직이 있다면 '// TODO: {Description}' 을 사용하여 잊지 않도록 할 것을 권장.