Javascriptのドキュメント生成

Question

私が開発したjavascriptコードを文書化して、いくつかの良いjavascriptドキュメントジェネレータを探していますが、誰にも何か提案はありますか？

私たちは、C＃コードのドキュメントを作成するためにされたNdocを使用するために使用され、私たちのJSコードを文書に類似した何かを探しています - コマンドラインから実行することができ、理想的なもの。

ありがとうございます！

Answer 1

あなたはそのために有名なJSDoc-Toolkitを使用することができます。

JSDocのツールキットは が自動的にテンプレート形式の生成のために、JavaScriptで書かれたアプリケーションであり、複数ページのHTML（またはXML、 JSON、または任意の他のテキストベースの）コメントのJavaScript ソースコードからドキュメント。

また、それにはcommand line optionsもあります。

Answer 2

JSDocのがコメントしたJavaScriptからのドキュメントを生成するためのアプローチです。

• これはもともとはPerlで実装されていました。
• JSDoc-Toolkit JavaScriptに移植しましたが、Javaで書かれたRhino JavaScriptエンジンを使用するため、Javaが必要です。
• node.js JavaScriptエンジン/プラットフォームで直接動作するように複数の人が移植されました。 node-jsdoc-toolkit。
• doxものNode.js上で実行され、それはJSDocのようなタグやマークダウンマークアップを組み合わせたものの（スタックオーバーフローとgithubの上で使用されるような）別個のテンプレートエンジンを必要とします。

すべては、コマンドラインから実行します。あなたのツール設定に従って選択してください。私はnode.jsの速度とすべてのJavaScriptのすべての時間の感じが好きです。 DailyJS「フレームワークを作ろう」post on writing documentationは、これらのツールと他のツールについて説明しています。残念なことに、doxはJSON構造体が出力されたので、根本的に見直されました。

https://stackoverflow.com/q/1221413/1162195は、他のJavaScriptドキュメンテーションジェネレータを言及しています。