0

問題:
SCParserDelegate プロトコルの例では、メソッドごとにドキュメント コメントが書かれているはずです。


コンテキスト:
サード パーティの開発者が使用する解析フレームワークを構築しています。(これは私の最初のフレームワーク プロジェクトであるため、私の開発プロセスは学習を最大化するための高度なアカデミックです。)


サンプルコード:

/** @protocol SCParserDelegate
 *   @brief Protocol for a Delegate to handle Callbacks when an SCParser finds Tags
 */
@protocol SCParserDelegate
@required
@property (readonly) BOOL processing;
@optional
-(void)parserDidStart:(SCParser *)parser;
-(void)parserDidFinish:(SCParser *)parser;
-(void)parser:(SCParser *)parser didOpenTag:(SCTag *)tag;
-(void)parser:(SCParser *)parser didCloseTag:(SCTag *)tag;
-(void)parser:(SCParser *)parser didSingleTag:(SCTag *)tag;
-(void)parser:(SCParser *)parser whitelistDeniedTag:(SCTag *)tag;
-(void)parser:(SCParser *)parser parseErrorOccurred:(NSError *)parseError;
-(void)parser:(SCParser *)parser foundCharacters:(NSString *)content;
@end


質問:
上記のサンプル コード内のメソッドとプロパティごとに独自のドキュメント コメント ブロックを手動で記述するにはどうすればよいですか?

4

2 に答える 2

1

NSHipster はこれについて良いコメントをしています。http://nshipster.com/documentation/

デリゲートに関しては、メッセージがいつ送信されるかをプロトコルに準拠している人に通知するのは良いことです。たとえば、次のようになります。

/*!
 * @field processing   Flag indicating that the operation is currently in process
 */
@property (readonly) BOOL processing;

/*!
 * Sent right after the parser began
 * 
 * @param parser (Something about the parser)
 */
-(void)parserDidStart:(SCParser *)parser;

/*!
 * Sent after the parser opens the given tag (maybe some hints as to what the delegate may do)
 *
 * @param parser (Words about the parser)
 * @param tag    (Something about the tag)
 */
-(void)parser:(SCParser *)parser didOpenTag:(SCTag *)tag;

@return や @warning などの便利なタグが他にもあります。VVDocumenter は非常に便利なので、インストールすることをお勧めします。

于 2014-02-18T20:19:58.743 に答える