9

私はここでAppleのようなHTMLドキュメントを生成する方法についての記事を読んでいます。私の質問は、コマンドラインが何に使用されるかです。コマンドラインとappledocxcodeプロジェクトを組み合わせてHTMLを生成するにはどうすればよいですか。

4

3 に答える 3

19

私はappledocツールの作者です。このツールは、上記のCalebが回答したとおりに使用することを目的としています。推奨されるインストール方法は、GitHubからリポジトリのクローンを作成し、Xcodeでプロジェクトを開き、上記のようにバイナリをビルドして、オプションでパスにコピーすることです。さらに、ツールの実行に必要なテンプレートファイルを事前定義されたパスの1つにコピーする必要もあります。必要なすべての手順は、GitHubのappledocページのreadmeファイルに記載されています。クイックインストールのセクションを参照してください。

インストールする他の方法もあります-ユーザーからのすべての貢献：

  • install-appledoc.shgitリポジトリに含まれているスクリプトを使用できます。
  • 私の理解ではテンプレートファイルをインストールしませんが、自作レシピも利用できます（このリンクを参照）。

その他の質問については、appledocGoogleグループにアクセスしてください。数日前に作成したばかりなので、現時点では内容はありませんが、お気軽にご質問ください。

于 2012-03-27T11:49:42.673 に答える
13

'appledoc'は使用していませんが、リンクしたページをざっと見てみると、オープンソースのコマンドラインユーティリティであるように見えます。したがって、最初のステップは、「appledoc」プログラム自体をコンパイルしてから、/usr/local/binまたはなどのパスにあるディレクトリに貼り付けること~/bin/です。

次のステップは、それを使用していくつかのドキュメントを生成しようとすることです（それが消費するマークダウンファイルをすでに作成していると仮定します）。ターミナルウィンドウを開き、ファイルがあるディレクトリに移動して、リンクしたページの上部にあるコマンドを使用します。

appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help .

プロジェクトをビルドするたびに「appledoc」を使用してドキュメントを再生成する場合は、プロジェクト内の既存のターゲットに「スクリプトの実行」ビルドフェーズを追加するか、ドキュメント専用の新しいターゲットを作成できます。 「スクリプトの実行」ビルドフェーズ。いずれにせよ、そのフェーズのスクリプトは、上記のようなコマンドを含むシェルスクリプトである必要があります（ただし、「現在の」ディレクトリを使用するのではなく、ソースディレクトリを明示的に指定することをお勧めします.。

于 2012-03-21T16:15:47.217 に答える
4

この投稿で見つけたように、次のコマンドラインを使用してコードの完全なHTMLドキュメントを生成できます。

appledoc --project-name BabelCPP --project-company "My Name" --company-id com.mycompany --no-create-docset --output./doc/。

最後 "。" コードへのパスです。

于 2014-04-24T19:52:20.773 に答える