6

HTMLドキュメントを生成するこの形式のJavaScriptおよびプロセッサのコメントドキュメント形式はありますか?JavaScriptの文書形式はどの方面に適していますか?

現在、開発時にIntelliSenseヘルプを提供するためにVSDoc xmlコメントを使用していますが、このようなコメントのためのドキュメントジェネレータはありません。 代わりに私の質問は次のように聞こえるかもしれません:VSDocコメントをJavaScriptファイルからHTMLに変換するユーティリティはありますか?

+0

YUI Doc?....... –

+0

[docco](http://jashkenas.github.com/docco/) – Raynos

答えて

9

JavaDoc、VSDoc、JSDocなどの自動生成ドキュメントを見てきましたか?

これらはすべて醜い読み込み不能です。

ソリューションは

私たちが自動生成されたドキュメントを作成する方法に革命を起こす3番目のオプションがあります。

1

私はいくつかのプロジェクトにNatural Docsを使用しました。構文はインラインを読むのにはいいですが、JavaScriptには "完全な言語サポート"がないので、ドキュメント化したい関数/定数/クラス/についてそれぞれ明示的に指定する必要があります。あなたは同じコメントからVSのインテリセンスを取得し、出力したい任意のフォーマットできるようAjaxDoc

その方法:JavaScriptファイルを解析し、同じXMLフォーマットされたNdocとサンドキャッスル使用を出力ユーティリティがあり