Objective-Cの一般的に受け入れられているドキュメントジェネレータはありますか(RubyのRDocに似ています)?私はDoxygenとObjcDocを見たことがあり、どれが最も広く使われているのだろうと思っています。Objective-Cのドキュメントジェネレータ?
答えて
Doxygenがおそらく最も広く使用されているオプションです。 ObjCだけではないので(Doxygenは他の多くの言語もサポートしています)、開発は活発でコミュニティはかなり強力です。比較対象となるのはHeaderDoc(現在はオープンソースプロジェクト)であり、大幅に停滞しているようです。 HeaderDocはHTML出力のみを生成し、DoxygenはHTML以外のPDF、LaTeXなどの出力フォームも生成します。 AppleはDoxygenを推奨しているようですが、thisガイドは、Xcodeのヘルプビューアと互換性のあるドキュメントセットをXcodeのビルドプロセスから自動的に生成するためのガイドです。
DoxygenはHeaderDocスタイルのコメントを読むことができるので、ドキュメントをHeaderDocスタイルで記述し、DoxygenまたはHeaderDocを使用して最終出力を生成するかどうかを後で決定することができます。
Doxygenは非常に広く使用されています。私は1週間に1度程度の答えとしてそれを使用しているようです。
doxygenだけでなく、appleには開発ツールに付属するツールがあります。これは、SystenConfigurationフレームワークのようなものに表示されるドキュメントの種類を生成します。このツールはHeaderDocと呼ばれ、ドキュメントはHeaderDoc User Guideにあります。
HeaderDocの開発はかなり停滞しています。 Doxygenはもっと良い選択です。適切なアドオンを使用すると、Doxygenの出力をHeaderDocとよく似たようにすることができます。 –
これは、Objective-C/C/C++のドキュメントを生成するための有効なオプションです。私は個人的にDoxygenが生成するドキュメンテーションを嫌いです。 –
それは私が探していたものです! MacでXcodeでコーディングする場合は、Appleがとにかく使うものを使わないでください。 – Nils
appledocをご覧ください。それはDoxygenに基づいています。あなたはappledoc source codeのためにappledoc reference documentationを生成するという点で、自分の犬の食べ物を食べることがわかります。たとえば、GBComment.h
〜GBComment
Class Referenceを比較してください。
また、Xcodeので動作するドキュメントを作成する方法についての包括的な説明についてはXcode's Documentation Set Guideを見てみましょう。これらは、appledocが自動化する指示です。
最近DoxygenからAppledocに切り替えました。遠方にあります。IMOは、Appleのdocsのために得られるすべての情報を、簡単なポップアップヘルプバブル(option-click)が持っていることです。Doxygenによって生成されたdocsetsは正しい構造を持っていません。 – DougW
あなたがリンクしている2つのガイドが[コメントを書くためにここに移動しました](http://gentlebytes.com/appledoc-docs-comments/)と[コマンドラインの設定例](http:// gentlebytes.com/appledoc-docs-settings/) –
NB:Appledoc 2はもはやDoxygenに基づいていません –
多分jazzyでRealmを試してください。オープンソースプロジェクトです。 jazzy
は両方ともObjective-C & Swiftをサポートしています。
"出力は、アップルの公式リファレンスドキュメントの外観と一致します(WWDC 2014以降)。あなたはそれが提供するsample docから判断できます。
- 1. ライブラリiphone用ドキュメントジェネレータ
- 2. HTMLドキュメントジェネレータfor .NET
- 3. NumberFormatter - ObjectiveC
- 4. ObjectiveCのAMF0パーサー
- 5. ObjectiveC blocks Java equivalent
- 6. RubyDoc.infoやYARDのようなJavascriptのドキュメントジェネレータ?
- 7. ObjectiveCの静的変数
- 8. Node.jsまたはExpress.js REST APIドキュメントジェネレータ
- 9. ObjectiveC /ココアScreencapture /クロスヘッドマウスポインタのセレクタのヘルプ
- 10. ObjectiveC/iPhoneのTwitPic APIを使用
- 11. GCCとObjectiveCコードとCygwinのヘルプ
- 12. 2D動的メモリ割り当て - ObjectiveC
- 13. iPhone/Objectivec-Cフロート分割誤っ出力
- 14. Yiiドキュメントジェネレータがdocsコマンドを受け付けていない
- 15. Rubyに相当するSphinxドキュメントジェネレータですか?
- 16. ObjectiveCでカスタムクラスのデリゲートを実装するときの参照カウント
- 17. Sphinx HTMLドキュメントジェネレータ:1つのHTMLファイルにクラス属性が重複しています
- 18. ObjectiveC-PHP:文字列とセキュリティの問題を渡す
- 19. ObjectiveCのNSStringから改行を分割する方法
- 20. <a href="https://github.com/google/google-api-objectivec-client" rel="noreferrer">google-api-objectivec-client</a>ライブラリの<a href="https://github.com/google/google-api-objectivec-client/wiki#threading" rel="noreferrer">documentation</a>によるObjective Cの中でGoogleドライブサービスの
- 21. objectiveCからjavascript関数を呼び出す
- 22. ObjectiveC - 分散オブジェクトを介してウィンドウを表示
- 23. DarwinとObjectiveC - Cocoaアプリケーションからシェルスクリプトを呼び出す方法は?
- 24. ObjectiveC - オブジェクトをパラメータとして追加して解放します。
- 25. ファイルから読み込む推奨タイプplist、string、rich text-objectiveC
- 26. ObjectiveC UISwitchはデフォルトでOFFに設定されています
- 27. gdata-objectivec-clientを通してyoutubeビデオをダウンロードする
- 28. サンプル「gdata-objectivec-client」で「invalid_client」エラーが発生しました
- 29. ObjectiveC/Cでフリーダイヤル・ブリッジを実装する方法は?
- 30. AFNetworking 3.Xを使用してBOOLをJSONにポストするObjectiveC
[更新](http://stackoverflow.com/questions/813529/documentation-generator-for-objective-c/6487090#6487090):appledocは新しく改良されたソリューションです。 "[それは]ソースファイルからドキュメントを抽出するためのベースとしてdoxygenを使用し、doxygenの出力をより見栄えの良いレイアウトに変換します。" – ma11hew28
appledocは問題があります - あなたはあなたのドキュメントやあなたのウェブサイトに属性を必要とします。いつフォーマッタが属性を必要としますか? –