Javascript 有JSDoc标准吗?

Javascript 有JSDoc标准吗?,javascript,standards,jsdoc,Javascript,Standards,Jsdoc,我知道有各种口味的JSDoc。而且JSDoc解析器的每个实现似乎都能识别自己的一组标记。例如,考虑标签之间和./p>之间的差异。 在这一点上,我只是感到困惑。是否有JSDoc的规范化实现或一组广泛认可的核心标记?有没有最好的JSDoc实现 编辑 正如下面的评论中所提到的,这个问题的原因是我需要解析JSDoc注释,以便与我们正在创建的工具一起使用。见这个问题: 我担心我将不得不使用自己的解析器,如果我这样做,我需要知道需要支持哪些标记 但是,在更深层次上,我担心没有一致的规范(或参考实现)。这让

我知道有各种口味的JSDoc。而且JSDoc解析器的每个实现似乎都能识别自己的一组标记。例如,考虑标签之间和./p>之间的差异。 在这一点上,我只是感到困惑。是否有JSDoc的规范化实现或一组广泛认可的核心标记?有没有最好的JSDoc实现


编辑

正如下面的评论中所提到的,这个问题的原因是我需要解析JSDoc注释,以便与我们正在创建的工具一起使用。见这个问题:

我担心我将不得不使用自己的解析器,如果我这样做,我需要知道需要支持哪些标记


但是,在更深层次上,我担心没有一致的规范(或参考实现)。这让我觉得JSDoc有点特别。

我认为最完整的功能是

使用googleclosurecompiler最酷的一点是,它可以对标记了类型信息的函数进行类型检查

我感觉到了你的痛苦,我整天都在处理这个问题。下面是一个非标准功能的例子,我必须编写/doc。使用
@cfg
来记录传递到小部件中的初始化对象的属性。我使用的IDE IntelliJ使用JSDoc来提供更好的代码建议,它甚至可以理解Ext的方言。对于但是,很多时候我不得不以某种方式复制文档,以使我的IDE和文档工具(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
...

我也和你一样感到痛苦。这不是标准化的,这很恼人。虽然我同意Juan Mendes先生的观点,闭包编译器的功能是最完整的(而且可能是最棒的!),但是

我一直认为这里的标记列表是最接近真实规范的东西。它可能已经过时了,但仍然可能更接近许多解析器和IDE实现的东西,而不是闭包编译器

另请参阅维基百科,了解关于标签应该存在的最低共识


虽然如果您的产品支持JSDoc的闭包编译器风格,这将使它更接近实际标准。:D

这将有助于了解您的具体问题。您是否从一个文档生成工具切换到另一个文档生成工具?或者这是一个假设,因此您可以在将来具有灵活性?哪些标记可以你想在所有的实现中都使用它吗?恐怕JSDoc还不是一个标准。这有点像有JScript和JavaScript的时候,但没有ECMAScript,对吧……但是如果没有标准(大写“s”),我没问题,但我想知道是否有一个非官方的标准(小写“s”)它的使用方法和实现它的工具。最后,我们使用了闭包编译器语法。它似乎是我所发现的所有jsdoc风格中最完整、记录最完整的。