JSDocと同様の機能を備えたJavascriptAPIドキュメントフレームワークを探していますが、コードコメント(htmlではなく)で入力しやすい再構成されたテキストまたはマークダウンを使用します
ボーナス:Sphinxとうまく統合できます。ただし、個別のドキュメントを維持したくはありませんが、コメントからAPIドキュメントを生成します。
JSDocと同様の機能を備えたJavascriptAPIドキュメントフレームワークを探していますが、コードコメント(htmlではなく)で入力しやすい再構成されたテキストまたはマークダウンを使用します
ボーナス:Sphinxとうまく統合できます。ただし、個別のドキュメントを維持したくはありませんが、コメントからAPIドキュメントを生成します。
最終的に、JSDuck がタスクに最も適していることがわかりました。
InvisibleJSは、マークダウンやその他のさまざまな形式をサポートしています。
docco もご覧ください。
jsdoc-toolkit のマークダウン プラグインをまだ探している方は、次のリンクで「smartdown」というプラグインをご覧ください。
https://github.com/sproutcore/docs
(構文の詳細: http://guides.sproutcore.com/documentation_guidelines.html )
次のテンプレート (jsdoc-toolkit-rst-template、jsdoc-for-sphinx) を使用して sphinx で試してみましたが、問題なく動作します。
JSDoc 3 は、プラグインによるマークダウンをサポートするようになりました。次の行を追加して、マークダウン サポートを構成できます。
"plugins": [ "plugins/markdown" ],
構成 JSON ファイルに追加します。
これで、JSDoc を で開始すると、マークダウン-c conf.json
サポートが有効になります。