#1 Swift2에서 향상된 주석 태그 요약에서 나는 라인 포맷을 썼다.
이번에는 Symbol Section을 쓰겠습니다.
동기화 세그먼트는 메소드 매개 변수와 반환 값을 쓰는 형식입니다.
참고로 Symbol Section 사용 VVDocumenter-Xcode 이 Xcode 플러그인은 간단하게 기술할 수 있기 때문에 추천합니다.
여기 문서 있습니다.

기본 형식

매개 변수

- 매개변수 이름: 세부 정보 형식으로 나열됩니다.
여러 매개변수가 있는 경우
"- 매개변수 이름: 세부 정보"를 쓰고 다음 줄에 "- 매개변수 이름: 세부 정보"를 쓸 수도 있습니다.

/**
- parameter パラメータ名1: 詳細
- parameter パラメータ名2: 詳細
*/

複数のパラメータがある場合には以下の書き方も可能
/**
- parameters:
    - パラメータ名1: 詳細
    - パラメータ名2: 詳細
*/

반환값

반환 값은 - 반환: 세부 정보에서 찾을 수 있습니다.

/**
- returns: 戻り値詳細
*/

오류 처리

오류를 되돌릴 수 있는 방법이라면 오류를 던지는 상세한 상황을 쓸 수 있다.
형식은 "-throws: 세부 정보"입니다.

/**
- throws: 詳細
*/

예제 표시

보조 표시 명령

방법의 상세한 부분은 상세한 설명을 위한 기호를 제공한다.
기본적인 기술 방법은'- 신호의 이름: 상세'이다.
Authors의 설명 방법만 다르지만 여기에는 관련이 없습니다.
부호
컨텐트
attention
주의사항
author
창립자
authors
다중 작성자
bug
구린내 나는 벌레
complexity
복잡성
copyright
제비청석
date
날짜
experiment
실험 내용
important
중요 사항
invariant
일정한 내용
note
공책
precondition
필수 사항
postcondition
후항
remark
관심
requires
필요 사항
seealso
참조
since
작성 날짜
todo
To Do
version
버전
warning
경고 사항

특수 주석

Objective-C에서 자주 사용하는'#pragmamark'에 해당하는 댓글도 준비되어 있다.
ARK:TODO:FIXME:.
#pragma mark-와 유사하게 MARK:-에 행을 삽입합니다.

// MARK: -
// MARK: private methods
func sample() {
    // TODO: 処理を書く

    // FIXME: 修正する
}

예제 표시

홍보 좀 해주세요.

저서인 《Swift2 표준 안내서》에도 이 평론 기술 방법에 대한 좋은 기록이 있다.
2015년 11월 24일까지 특별 가격이니 자세한 내용을 알고 싶으신 분들은 꼭 사세요.

Amazon (Kindle)

이터레이션(PDF)

달인 출판회(PDF)