5

JSDocと同様の機能を備えたJavascriptAPIドキュメントフレームワークを探していますが、コードコメント(htmlではなく)で入力しやすい再構成されたテキストまたはマークダウンを使用します

ボーナス:Sphinxとうまく統合できます。ただし、個別のドキュメントを維持したくはありませんが、コメントからAPIドキュメントを生成します。

http://code.google.com/p/jsdoc-toolkit/

4

4 に答える 4

6

最終的に、JSDuck がタスクに最も適していることがわかりました。

https://github.com/senchalabs/jsduck

于 2011-08-22T20:40:23.647 に答える
3

InvisibleJSは、マークダウンやその他のさまざまな形式をサポートしています。

docco もご覧ください。

于 2011-08-11T20:20:01.130 に答える
1

jsdoc-toolkit のマークダウン プラグインをまだ探している方は、次のリンクで「smartdown」というプラグインをご覧ください。

https://github.com/sproutcore/docs

(構文の詳細: http://guides.sproutcore.com/documentation_guidelines.html )

次のテンプレート (jsdoc-toolkit-rst-template、jsdoc-for-sphinx) を使用して sphinx で試してみましたが、問題なく動作します。

于 2014-04-30T10:53:55.880 に答える
1

JSDoc 3 は、プラグインによるマークダウンをサポートするようになりました。次の行を追加して、マークダウン サポートを構成できます。

"plugins": [ "plugins/markdown" ],

構成 JSON ファイルに追加します。

これで、JSDoc を で開始すると、マークダウン-c conf.jsonサポートが有効になります。

于 2013-03-18T08:17:37.387 に答える