有JSDoc标准吗？

Question

我知道JSDoc有各种各样的风格.并且似乎JSDoc解析器的每个实现都识别它自己的标记集.例如,考虑http://usejsdoc.org/和http://www.techrepublic.com/blog/programming-and-development/create-useful-relevant-javascript-documentation-with-jsdoc/之间标签的差异451.

在这一点上,我只是困惑.是否有规范的JSDoc实现或广泛认可的核心标记集？是否有最佳的JSDoc实现？

---

编辑

正如下面评论中所提到的,这个问题的原因是我需要解析JSDoc注释以便与我们正在创建的工具一起使用.看到这个问题":是否有用Javascript编写的开源JSDoc解析器？

我担心我将不得不推出自己的解析器,如果我这样做,我需要知道需要支持哪些标签.

但是,在更深层次上,对我而言,没有一致的规范(或参考实现).这让JSDoc对我有点特别.

Answer 1

我认为最完整的功能是google closure编译器使用的功能

使用谷歌闭包编译器的一个很酷的事情是,它将对已标记有类型信息的函数进行类型检查.

我感觉到你的痛苦,我整天都在处理这件事.这是我必须编写代码/文档的非标准功能的示例.Ext-JS用于@cfg记录传递给窗口小部件的初始化对象的属性.我使用的IDE IntelliJ使用JSDoc提供更好的代码建议,甚至可以理解Ext的方言.对于大多数事情,它运作良好.但是,很多时候我不得不以某种方式复制文档以使我的IDE和doc工具(Ext的jsdoc版本)理解它,而不是非常干.这是一个例子:

...
/** 
 * @cfg {string} title // Ext-JS grabs the type from this line
 * @type string // My IDE grabs the type from this line
 */
 title: null // My IDE requires this line to recognize the cfg
             // as a property of the object even though all cfgs
             // are available in the object
...