Doxygenを使用して、ObjectiveCコードのドキュメントを生成します。しかし今まで、プロパティを正しく文書化する方法についてのガイドラインを見つけることができませんでした。私が見た例は、考えられるあらゆる方法でそれを行います。変数自体を文書化する人もいれば、@property宣言を文書化する人もいます。//を使用するものもあれば、完全な/ ***/ブロックを使用するものもあります。
誰かが私にベストプラクティスのリファレンスを教えてもらえますか？それとも、Doxygenとの将来の互換性に関する情報ですか？少なくとも、公式のパターンを開発すれば、Doxygenに簡単に適応できるパターンに固執したいと思います。
私が言えるのは、Core Plotフレームワークが、次のような形式を使用して、実装内のプロパティ宣言に注釈を付けることです。
/** @property myProperty
* @brief Property is very useful
* Useful and there is a lot more to tell about this property **/
Doxygenを使用してクリーンなドキュメントを作成しているようです。コアプロットのドキュメントポリシーから：
doxygenはプロパティ名を見つけることができないため、@propertyが必要です。
読み取り専用、コピー/保持/割り当て、非アトミックなどのアクセサプロパティは自動的に追加されるため、ドキュメントの手動部分には表示されません。
ここでは、Objective-Cのコーディング規約に関する情報を見つけることができます：GoogleObjective-Cスタイルガイド
ただし、必要に応じて、XCodeでドキュメントを生成するHeaderDocと呼ばれる他の優れたソフトがあります。ここでコーディングスタイルを確認できます：HeaderDocタグ
私の経験は：
コメント内で@propertyタグを使用すると、プロパティのdoxygen出力が[ClassName]：[read、write、assign]のように破損します。
@propertyタグを省略し、代わりにdoxygenがソースコードのコメントブロックのすぐ下にある「@property」宣言を見つけることに依存している場合、すべてが正常に機能します。
対照的に、@ interfaceはインターフェースに対しては正常に機能し、@protocolはプロトコルに対して正常に機能します。
また、過去には、いくつかのプロトコル宣言でdoxygen'slip'がありました。Obj-Cはまだ二流のdoxygen市民ですか？
注：私はMacでGUI / Wizardを使用しており、コメントブロックは「/ * *！」を使用しています。'/ ** 'の代わりに。