Objective-Cの一般的に受け入れられているドキュメントジェネレーター(RubyのRDocに類似)はありますか?私はDoxygenとObjcDocを見てきましたが、どちらが最も広く使用されているのか疑問に思っています。
Doxygen はおそらく最も広く使用されているオプションです。これはObjC(doxygenが他の多くの言語をサポートしている)専用ではないため、開発は活発で、コミュニティーは非常に強力です。 HeaderDoc (現在はオープンソースプロジェクトです)と比較すると、概して停滞しているようです。 HeaderDocはHTML出力のみを生成しますが、doxygenはPDF、LaTeX、およびHTML以外の他の多くの出力形式も生成します。 Appleでもdoxygenを推奨しているようです this Xcodeのヘルプビューアと互換性のあるドキュメントセットをXcodeビルドプロセス内から自動的に作成するためのガイド。
DoxygenがHeaderDocスタイルのコメントを読み取ることができるため、HeaderDocスタイルでドキュメントを記述し、後でdoxygenまたはHeaderDocを使用して最終的な出力を生成するかどうかを決定できることに注意してください。
appledoc をチェックしてください。 Doxygen に基づいています。 appledoc source code に対して appledoc reference documentation を生成することで、独自のドッグフードを食べることがわかります。たとえば、比較 GBComment.h
から GBComment
クラス参照 へ。
また、Xcodeで動作するドキュメントの作成方法に関する包括的な説明については、 Xcodeのドキュメントセットガイド を参照してください。これらは、appledocが自動化する命令です。
Doxygenは非常に広く使用されています。 SO週に一回程度の回答としても使っているようです。
新しいツールは Jazzy by Realmで、新しいXcode 6スタイルでドキュメントを生成し、Swiftドキュメント(およびObjective-C)の生成)をサポートします。
Appleには、開発ツールに付属するツールがあります。SystenConfigurationフレームワークなどに表示される種類のドキュメントを生成します。このツールはHeaderDocと呼ばれ、ドキュメントは次の場所にあります。 HeaderDocユーザーガイド 。
jazzy by Realm を試してみてください。これはオープンソースプロジェクトです。 jazzy
は、Objective-CとSwiftの両方をサポートしています。
「出力は、WWDC 2014以降のAppleの公式リファレンスドキュメントのルックアンドフィールと一致しています。」 サンプルドキュメント から判断できます。