Skip to content

Natural Docsによるドキュメントの作成(日本語訳)

原文

これですべての設定が完了し、コードをコメントしたので、Natural Docsを実行する必要があります。ドキュメントを構築するコマンドは、NaturalDocs.exeとプロジェクト構成フォルダの組み合わせだけです。

NaturalDocs.exe C:\My Project\ND Config

完成したら、Project.txtに入れた出力フォルダに移動してindex.htmlを開いてください。これでドキュメントの完成です。

更新を続ける

ドキュメントを更新したいときは、いつでも同じコマンドを再実行すればよいのです。

NaturalDocs.exe C:\My Project\ND Config

すでにブラウザーのウィンドウで開いていた場合は、ページを再読み込みすれば変更が反映されます。

Natural Docsのビルドプロセスは差分処理で、実行するたびに前回の実行以降に変更されたものを探し、ドキュメントのその部分のみを更新します。これは最初の実行よりも後の実行がはるかに高速であることを意味するので、作業中に頻繁に実行することができます。

Natural Docsはコマンドラインツールであるため、ほとんどの開発環境に統合することができます。ビルドプロセスのビルド前またはビルド後のイベントとして追加できますが、個人的にはVisual Studioの外部ツールとして構成して、ビルドの間でもキーボードショートカットで好きなときに実行できるようにしています。他のほとんどの開発環境にも同様の機能があるはずです。

Natural Docsはコンソールに書き込むため、ほとんどの開発環境はそのステータスメッセージをキャプチャして、自分自身で表示することができます。しかし、ポップアップコンソールウィンドウで実行する場合、いくつかのコマンドラインオプションについて知っておく必要があります。-pause-before-exitはNatural Docsにキーが押されるのを待ってから終了するように指示し、ウィンドウが消える前にステータスメッセージを表示する時間を確保します。--pause-on-errorもこれを行いますが、問題がある場合のみです。ウィンドウは開いたままなのでエラーメッセージを見ることができますが、すべてが正常に終了すると自動的に閉じます。