/** @discussion @param @ Objective-Cのコメントドキュメント*/

Question

このような@markerの見方は、/ ** * /とコメントを付けてますます増えています。いくつかのドキュメント、それらの説明、使用方法などを探しています。ありがとう！

/** 
@param blabla... 
@return bla... 
@see ... 
@method ... 
@discussion ... 
*/ 

Answer 1

これは、自己文書化コードに対する特別なアプローチのインライン（よくコメントします）ドキュメントです。この特定のスタイルはJavadocスタイルと呼ばれ、Javadocツールとは別に、DoxygenとAppledocを含む多くの一般的なドキュメントジェネレータがサポートしています。

いくつかのコード（アプリケーション、ライブラリなど）のドキュメントを作成する目的は、開発者がコードベースを維持する必要がないことです。とは、これらの自動ユーティリティは、コメントに埋め込まれた情報からうまくフォーマットされた（例えば、HTML）文書を生成することができる。

また、これは厳密に言語依存機能ではありません。 @（at）記号と混同しないでください。これはObjective-C固有の構文ではなく（むしろ、使用される特定の文書生成プログラムに固有のものです）。