Javascript文档

Question

Javascript的JavaDocs有什么用吗？当我在netbeans IDE中按ctrl + space时

写javascript,javascript文档出来指定对象.但是这个文档是我猜Netbeans的财产.

如果我们以适当的评论方式编写javascript,Netbeans也会为我们的自定义javascript构建文档.

我们可以在Netbeans之外找到任何这样的javascript文档吗？那么我们可以参考一下吗？

谢谢你的回答.

Answer 1

查看Mozilla Developer Network(MDN)上的doc页面以获取静态参考:

• https://developer.mozilla.org/en/JavaScript/Reference
• https://developer.mozilla.org/en/JavaScript/Guide

但是,我担心没有可以在IDE中使用的制表符完成.

Answer 2

在谷歌的主页涂鸦源代码中,他们使用与javadoc评论非常相似的评论,因此必须有一些至少谷歌使用的标准.

这是一个例子:

/**
 * Configuration for a simulator speed setting.
 * - stepTime: ms between simulation steps that do something.
 * - emptyStepTime: ms between no-op steps.
 * - tapeTime: ms for a tape operation.
 * - branchTime: ms for a branch operation.
 * @typedef {{stepTime: number, tapeTime: number, emptyStepTime: number,
 *            branchTime: number}}
 * @private
 */