javascript - GitHub：在代码注释/文档块中渲染降价？

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 。