개요

문서 평론의 작성법을 자주 잊어버리기 때문에 사용 빈도가 높은 것을 간단하게 정리했다.

전제 환경

Item
Version
Xcode
8.x
Swift
3.x

기본 기법

/// サンプルメソッド
///
/// - Parameters:
///   - paramA: パラメータAの説明
///   - paramB: パラメータBの説明
/// - Returns: 戻り値の説明
func sampleMethod(paramA: String, paramB: String) -> String {
    return paramA + paramB
}

호출자에서 [alt] 키를 누르면 다음과 같은 문서 주석이 표시됩니다.

문서 주석 템플릿 삽입 방법

커서가 선언된 함수의 행 위에 있을 때 메뉴 모음에서 다음 옵션을 선택합니다.

Editor > Structure > Add Documentation

그리고 이런 느낌으로 템플릿을 삽입합니다.

특수 표시

// MARK: - 罫線付きのセクション見出し
// TODO: 「後で○○しなければならない」の意味
// FIXME: 「○○を修正する必要がある」の意味

위의 특수 태그를 설명하면 Xcode는 다음과 같이 표시됩니다.

프로젝트에서 "TODO:"와 "FIXME:"가 기재된 곳을 일람표로 확인하는 방법 (Eclipse의'작업'보기 같은 기능) 을 찾아보았지만 문자열만 일반적으로 검색할 수 있는 것 같습니다

지원

상세한 정보는 여기에 기재되어 있다.
Markup Formatting Reference