javascript - GitHub:コード コメント/docblock でマークダウンをレンダリングしますか?

Question

github に JavaScript ファイルがあり、コメント ブロックにマークダウンを追加するとします。

/**
 * # Markdown here?
 * - list?
 * */
function MyClass(){
  this.someMethod = function(){
    // this method is added to each new instance
    // for this reason, adding your methods here can bloat
  };  
}

マークダウンとしてレンダリングするドキュメント ブロックまたはコメント ブロックを取得できますか?

Answer 1

いいえ、それは不可能です。

ただし、 Sphinxなどのツールを使用して外部ドキュメントを作成することもできます。マークダウンは使用しませんが、多少似ているReStructured Textを使用します。