iOS 에 주석 을 이렇게 써 요.

제 개인 블 로그 에 오신 걸 환영 합 니 다.http://liumh.com 이 글 탐색
이 글 은 주석 을 어떻게 더 잘 작성 하 는 지 기록 하고 있다.좋 은 주석 은 사용자 가 공식 문 서 를 사용 하 는 것 처럼 사용 option + 하면 사용 설명 을 볼 수 있 습 니 다.
매 거 유형 에 대해 서 는 다음 과 같이 할 수 있 습 니 다.

/**    HTTP     */
typedef NS_ENUM(NSUInteger, ACLApiManagerRequestType) {
    ACLApiManagerRequestTypeGet,   /**< Get   */
    ACLApiManagerRequestTypePost,  /**< Post   */
};

주석 에 사용 되 는 기호 에 주의 하 십시오. 주석 매 거 진 값 과 매 거 진 유형 에 사용 되 는 기호 도 차이 가 있 습 니 다.
속성 에 대해 서 는 다음 과 같이 할 수 있 습 니 다.

@property (nonatomic, copy, readonly) NSString *errorMessage;  /**<        */

방법 에 대한 설명 은 야옹 신의 플러그 인 VVDocumenter - Xcode 를 설치 하 는 것 을 강력 히 권장 합 니 다.그 다음 에 방법 상부 에 연속 으로 입력 /// 을 눌 러 주석 을 삽입 한 다음 에 placeholder 를 삭제 하고 실제 주석 설명 을 작성 합 니 다. 다음 과 같 습 니 다.

/**
 *  
 *
 *  @param manager 
 *  @param data    
 *
 *  @return 
 */
 - (BOOL)manager:(ACLAPIBaseManager *)manager isCorrectWithParamsData:(NSDictionary *)data;

그러나 매개 변수 가 없 는 방법 이나 우리 가 생각 하 는 방법의 명명 자체 해석 이 이미 명확 하 다 면 다음 과 같은 설명 을 할 수 있 습 니 다.

/** API     base url     url   */
- (NSString *)methodName;

참고:
Documentation