JavaScript 用のコメント ドキュメント形式と、HTML ドキュメントを生成するこの形式用のプロセッサはありますか?
現在、開発時に IntelliSense ヘルプを提供するために VSDoc xml コメントを使用していますが、私が知っているように、そのようなコメント用のドキュメント ジェネレーターはありません。代わりに、私の質問は次のように聞こえるかもしれません: VSDoc コメントを JavaScript ファイルから HTML に変換するユーティリティはありますか?
2943 次
3 に答える
9
JavaDoc、VSDoc、JSDoc などから自動生成されたドキュメントを見たことがありますか。
それらはすべて醜く、読めません。
解決策は2つあります
- コードに docco で注釈を付けます
- API ドキュメントを手書きで作成します。
自動生成ドキュメントの作成方法に革命を起こすという 3 つ目のオプションがあります。可能であれば実行してください。
于 2011-09-24T16:40:07.423 に答える
1
Javascriptファイルを解析し、NDocとSandcastleが使用するのと同じXML形式を出力するユーティリティがあります：AjaxDoc
そうすれば、同じコメントからVSインテリセンスを取得し、必要な形式を出力できます。
于 2012-02-22T17:29:27.260 に答える
1
いくつかのプロジェクトでNatural Docsを使用しました。構文はインラインを読むのに適していますが、JavaScript の「完全な言語サポート」がないため、各関数/定数/クラス/文書化したいものについて、ある程度明示する必要があります。
于 2011-09-24T19:27:10.757 に答える