GitHub：代码注释/ docblock中的渲染降价？

Question

我们说我有a javascript file in github，并在评论栏中添加一些降价：

/**
 * # 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
  };  
}

我可以将doc-blocks或comment块渲染为markdown吗？

Answer 1

不，那是不可能的。

但是，您可以使用Sphinx之类的工具创建外部文档 - 虽然它没有使用markdown，但它使用的 ReStructured Text 有点类似。