objective-c - コメントで @discussion を使用する利点は何ですか?

Question

いくつかのサンプル コードで @discussion を見ています。私の質問は、このキーワードを使用する利点は何ですか?

より良いドキュメントが生成されると思います。Google や Stackoverflow で検索してみましたが、このキーワードの使い方どころかコードサンプルがたくさん出てきました。ありがとう。

// Example
/*!
    @method     blabla method name
    @discussion blabla discuss here
    @param      blabla describe the parameters
    @result     blabla results
 */

Answer 1

@discussionAppleのHeaderDocで使用されるタグです。

このページには、次の説明が含まれています。

関数、クラス、ヘッダー、またはデータ型を詳細に説明するテキストのブロック。これには複数の段落が含まれる場合があります。上記のように、@discussionは省略できます。

データ型、関数、クラス、またはヘッダーにマルチワード名がある場合は、@discussionが存在する必要があります。

@discussionブロックは、@paramタグなどの別のブロックが開始したときにのみ終了します。

したがって、これは基本的に、少し誤解を招くタグ名を使用した説明です。