首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >有没有JSDoc标准?

有没有JSDoc标准?
EN

Stack Overflow用户
提问于 2012-08-08 02:14:49
回答 2查看 4.7K关注 0票数 16

我知道周围有很多不同口味的JSDoc。似乎JSDoc解析器的每个实现都能识别自己的一组标记。例如,考虑一下http://usejsdoc.org/http://www.techrepublic.com/blog/programming-and-development/create-useful-relevant-javascript-documentation-with-jsdoc/451之间在标记方面的差异。

在这一点上,我只是感到困惑。是否有JSDoc的规范实现或一组广泛认可的核心标记?有没有最好的JSDoc实现?

编辑

正如在下面的注释中所问的,这个问题的原因是我需要解析JSDoc注释,以便与我们正在创建的工具一起使用。查看此问题“:Are there any open source JSDoc parser written in Javascript?

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

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

EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2012-08-08 02:19:40

我认为最完整的功能是google closure compiler使用的功能

使用google closure编译器最酷的一件事是,它将对标记了类型信息的函数进行类型检查。

我能感受到你的痛苦,我整天都在处理这件事。这是一个非标准特性的示例,我必须对其进行编码/文档处理。Ext-JS使用@cfg来记录您传递给小部件的初始化对象的属性。我使用的集成开发环境IntelliJ使用JSDoc提供更好的代码建议,它甚至可以理解Ext的方言。在大多数情况下,它工作得很好。然而,很多时候我不得不以某种方式复制文档,以使我的IDE和doc工具(Ext版本的jsdoc)都能理解它,这并不是很枯燥。这里有一个例子:

代码语言:javascript
运行
复制
...
/** 
 * @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
...
票数 5
EN

Stack Overflow用户

发布于 2012-08-28 07:02:18

我也分担你的痛苦。令人恼火的是,这不是标准化的。虽然我同意Juan Mendes先生的观点,闭包编译器的特性是最完整的(可能也是最棒的!)

我一直认为在这里找到的http://code.google.com/p/jsdoc-toolkit/w/list标签列表是我们拥有的最接近真正规范的东西。它可能已经过时了,但它可能更接近于许多解析器和IDE的实现,而不是闭包编译器。

另请参阅维基百科,了解关于应该有哪些标签的最低限度的共识。http://en.wikipedia.org/wiki/JSDoc

不过,如果你的产品支持JSDoc的闭包编译器风格,这将使它离成为事实上的标准更近一步。:D

票数 4
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/11851722

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档