objective-c - /** @discussion @param @see @return .... に関する Objective-C コメント ドキュメント */

Question

/** */ にコメントが付いたこの種の @marker をますます見てきました。ドキュメント、それらが何であるか、およびその使用方法に関する説明を探しています。ありがとう！

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

Answer 1

これはインライン (コメント内) ドキュメントであり、自己文書化コードへの特別なアプローチです。この特定のスタイルはJavadocスタイルと呼ばれ、Javadoc ツールとは別に、DoxygenやAppledocなど、多くの一般的なドキュメント ジェネレーターがこのスタイルをサポートしています。

一部のコード (アプリケーション、ライブラリなど) のドキュメントを作成する目的は、開発者がドキュメント用のコードベースと別のファイル構造を維持する必要がないことです。これらの自動ユーティリティは、コメントに埋め込まれた情報から適切にフォーマットされた (HTML などの) ドキュメントを生成できます。

また、これは厳密には言語に依存する機能ではないことに注意してください。@ (アットマーク) 記号に惑わされないでください。これは Objective-C 固有の構文ではありません (むしろ、使用されている特定のドキュメント生成プログラムに固有のものです)。