Objective-Cのドキュメントジェネレータ？

Question

Objective-Cの一般的に受け入れられているドキュメントジェネレータはありますか（RubyのRDocに似ています）？私はDoxygenとObjcDocを見たことがあり、どれが最も広く使われているのだろうと思っています。

Answer 1

Doxygenがおそらく最も広く使用されているオプションです。 ObjCだけではないので（Doxygenは他の多くの言語もサポートしています）、開発は活発でコミュニティはかなり強力です。比較対象となるのはHeaderDoc（現在はオープンソースプロジェクト）であり、大幅に停滞しているようです。 HeaderDocはHTML出力のみを生成し、DoxygenはHTML以外のPDF、LaTeXなどの出力フォームも生成します。 AppleはDoxygenを推奨しているようですが、thisガイドは、Xcodeのヘルプビューアと互換性のあるドキュメントセットをXcodeのビルドプロセスから自動的に生成するためのガイドです。

DoxygenはHeaderDocスタイルのコメントを読むことができるので、ドキュメントをHeaderDocスタイルで記述し、DoxygenまたはHeaderDocを使用して最終出力を生成するかどうかを後で決定することができます。

Answer 2

Doxygenは非常に広く使用されています。私は1週間に1度程度の答えとしてそれを使用しているようです。

Answer 3

doxygenだけでなく、appleには開発ツールに付属するツールがあります。これは、SystenConfigurationフレームワークのようなものに表示されるドキュメントの種類を生成します。このツールはHeaderDocと呼ばれ、ドキュメントはHeaderDoc User Guideにあります。

Answer 4

appledocをご覧ください。それはDoxygenに基づいています。あなたはappledoc source codeのためにappledoc reference documentationを生成するという点で、自分の犬の食べ物を食べることがわかります。たとえば、GBComment.h〜GBComment Class Referenceを比較してください。

• appledoc: how to write comments
• appledoc examples of command line settings

また、Xcodeので動作するドキュメントを作成する方法についての包括的な説明についてはXcode's Documentation Set Guideを見てみましょう。これらは、appledocが自動化する指示です。

Answer 5

新しいツールは、新しいXcode 6スタイルのドキュメントを生成するRealmのJazzyであり、Swiftのドキュメント（Objective-Cと同様）の生成をサポートしています。

Answer 6

多分jazzyでRealmを試してください。オープンソースプロジェクトです。 jazzyは両方ともObjective-C & Swiftをサポートしています。

"出力は、アップルの公式リファレンスドキュメントの外観と一致します（WWDC 2014以降）。あなたはそれが提供するsample docから判断できます。