appledoc
2.2.1 build 1333
重要なお知らせ:協力者が必要です
appledoc は、Objective-C 開発者が特別にフォーマットされたソース コード コメントから Apple のようなソース コード ドキュメントを生成するのに役立つコマンド ライン ツールです。これは、入力として可能な限り読みやすいソース コード コメントを取得し、コメントと周囲のソース コードを使用して、視覚的に魅力的なドキュメントを HTML 形式で生成するとともに、完全にインデックス付けされ、参照可能な Xcode ドキュメント セットを生成するように設計されています。 Objective-C 用の HTML ドキュメントを作成できるツールはいくつかありますが、私が知っているツールはすべて、以下に説明する最低限の目標を満たすには不十分です。
appledoc の主な目標:
appledoc をできるだけスムーズに使用できるように、このドキュメント全体と、以下の「appledoc の使用」セクションで説明されているすべてのオンライン ドキュメントを読むことを強くお勧めします。
appledoc の使用は、このファイルの下部にあるライセンスセクションに記載されている条件に基づいて許可されています。
常に最新情報を入手したいですか? Twitter で @gentlebytes をフォローしてください。
推奨される方法は、GitHub プロジェクトのクローンを作成し、Xcode からツールをコンパイルすることです。 GitHub プロジェクトのクローンを作成すると、メイン リポジトリへのリンクが作成されるため、将来のアップグレードも大幅に簡素化されます。インストールするには、ターミナルに次のように入力します。
git clone git://github.com/tomaz/appledoc.git
これにより、appledoc ディレクトリが作成されます。その中に appledoc.xcworkspace Xcode ワークスペースがあります。それを開いて appledoc ターゲットをコンパイルします。これはすぐに機能するはずですが、システムは最小システム要件を満たしている必要があります。以下を参照してください。簡単にアクセスできるように、結果の appledoc 実行可能ファイルをビルド ディレクトリからパス ( echo $PATH ) 内のディレクトリの 1 つにコピーすることをお勧めします。
オプション: Appledoc は自己完結型であり、必要なテンプレート ファイルが含まれています。これらのデフォルトを Templates サブディレクトリから予期される場所の 1 つに変更する場合は、次のようにします。
install-appledoc.sh スクリプトを使用してクイック インストールを実行することもできます。ターミナルを開き、appledoc ディレクトリに切り替えます。次のコマンドを入力します。
sudo sh install-appledoc.sh (if you need templates add '-t default')
デフォルトでは、appledoc をコンパイルし、そのバイナリを /usr/local/bin にインストールし、テンプレート (必要な場合) を ~/.appledoc にインストールします。このディレクトリは、それぞれ -b および -t オプションでオーバーライドできます。例えば：
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application Support/appledoc
または Homebrew を使用する場合:
brew install appledoc
Homebrew はデフォルトではテンプレートをインストールしません。
すべてのコマンド ライン スイッチのリストを表示するには、 appledoc --helpを使用します。 appledoc の詳細については、appledoc サイトをご覧ください。さらに詳しい記事については、Wiki ページもお読みください。
使用方法やその他の一般的な質問については、appledoc Google グループをフォーラムとして使用してください。
appledoc の問題ページを使用して、バグや機能のリクエストを送信します。新しい問題を送信する前に、フォーラムをチェックして、そこで質問が回答されているかどうかを確認してください。問題が新しい機能リクエストまたはバグであると確認できない限り、GitHub の問題をクリーンに保つためにフォーラムから始める必要があります。また、問題を読んでその問題がすでに存在するかどうかを確認し、それに投票するかコメントを追加してください (終了した問題も忘れないでください)。
最新の状態に保つには、ターミナルに移動して appledoc ディレクトリに移動し、 git pull発行して appledoc.xcodeproj を再コンパイルします。 $PATH にコピーした appledoc 実行可能ファイルを上書きすることを忘れないでください:)
AppledocTests (単体テスト) ターゲットもコンパイルして実行したい場合は、単体テスト ターゲットを構築する前に、Libraries & Frameworks グループ内で示されているすべてのフレームワークを共有フレームワーク ディレクトリにコピーする必要があります。これは、appledoc ツール自体を構築する場合には必要ありません。
Appledoc ドキュメントの作成を自動化するように Xcode をセットアップできます。実行スクリプトとプロジェクトのビルド フェーズの使用方法を確認してください。
ほとんどの Cocoa フレームワーク用の事前に生成されたドキュメントとドキュメントセットは、次の場所から入手できます。
docset を取得したら、それをドキュメント ブラウザーで使用するとよいでしょう。
問題がありますか?トラブルシューティングのためにできることは次のとおりです。
git pull試し、最新バージョンで再度実行してください。--verboseコマンド ライン スイッチを使用して冗長レベルを上げます。デフォルトのレベルは 2 ですが、レベルごとに詳細度を最大 6 まで徐々に上げることができ、より詳細な情報が得られます。これにより、より多くの情報が得られるため、問題がある特定のソース ファイルのセットのみに集中することをお勧めします。冗長性を高めるとパフォーマンスが低下するため、日常的な使用には 4 を超えるレベルを使用することはお勧めできません。貢献したい場合は、Appledoc が内部でどのように動作するかについての簡単な概要については、開発者ノート ファイルを参照してください。
appledoc は修正された BSD ライセンスでライセンスされています。わかりやすい言葉で言うと、コードを変更、再配布、製品 (無料または商用) に埋め込むなど、好きなことを行うことができますが、ライセンスに記載されている著作権、使用条件、免責条項を含める必要があります。他の BSD ライセンス コードと同様に。もちろん、appledoc によって生成されたドキュメントを製品 (無料または商用) に使用することはできますが、ドキュメント自体または Web サイトなどの他の適切な場所で appledoc を帰属させる必要があります。
何らかの理由でこれらの規約に同意できない場合は、当社の概要ページにあるお問い合わせフォームからご連絡ください。最善を尽くしてお客様をサポートし、実行可能な解決策を見つけます。
著作権 (c) 2009-2011、Gentle Bytes 全著作権所有。
以下の条件が満たされる場合、ソース、バイナリ形式、生成されたドキュメントの再配布と使用は、変更の有無にかかわらず許可されます。
ソース コードを再配布する場合は、上記の著作権表示、この条件リスト、および次の免責事項を保持する必要があります。
バイナリ形式で再配布する場合は、上記の著作権表示、この条件リスト、および次の免責事項を、配布物とともに提供されるドキュメントおよび/またはその他の資料に複製する必要があります。
appledoc によって生成されたドキュメントの再配布には、ドキュメント自体または他の適切なメディアに appledoc への帰属を含める必要があります。
appledoc の名前、Gentle Bytes、またはその寄稿者の名前は、書面による事前の特別な許可がない限り、このソフトウェアから派生した製品を推奨または宣伝するために使用することはできません。
このソフトウェアは著作権者および寄稿者によって「現状のまま」提供され、商品性および特定目的への適合性の暗黙の保証を含むがこれに限定されない、明示的または黙示的な保証は一切否認されます。いかなる場合においても、著作権所有者または寄稿者は、直接的、間接的、偶発的、特別、例示的、または結果的損害（代替品またはサービスの調達、使用、データ、またはデータの損失を含みますがこれらに限定されません）に対して責任を負わないものとします。たとえその可能性について知らされていたとしても、契約上、厳格責任、または不法行為（過失またはその他を含む）のいずれかに起因するものであれ、いかなる責任理論に基づくものでも、 ダメージ。
ジェントルバイト [email protected]
