Javascript文档

Question

Javascript是否有类似JavaDocs的东西？当我在netbeans IDE中按ctrl + space时

编写javascript，javascript文档针对指定的对象出来。但是这个文档是我猜Netbeans＆＃39;属性。

如果我们以适当的评论方式编写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
 */

Answer 3

尝试一个名为Ortelius的应用程序。它使用某种类似javadoc的语法来生成文档。 ortelius.marten.dk