javascript - Netbeans javascript 评论

Question

我最近发现 Netbeans 非常喜欢这样格式的 javascript 注释:

/** * This is a sample comment *  * @param {Number} myParam info about this parameter * @return {String} Returns some sample string. */function sample(info) { .. }

这似乎是 Javadoc 兼容的注释，但它是吗？某处是否有资源定义可接受的格式？另外，这种注释风格是否常见于其他 IDE，例如 Eclipse？

编辑:我上传了这张截图来说明 Netbeans 如何解释@param 和@return

谢谢。

Answer 1

注释标签类似于JSDoc3，但并非所有的JSDoc3 标签都支持。 JSdocs 3 中缺少一些标签(它们在下面的列表中没有引用)。

您可以通过这种方式查看哪些可用:

• 使用/** 开始评论并按 Enter；
• 在评论中输入@;
• 使用 Ctrl + Space (Netbeans) 在 @ 符号后调用代码补全。

它将向您显示支持的标签列表并帮助您了解其语法(参数自动完成)。随着用户发布多个错误报告，预计 future 的 Netbeans 版本将支持更多标签。

以下是 Netbeans 7.4 支持的标签列表:

• @argument //定义参数类型、名称和描述。
• @augments //此对象添加到父对象上。
• @author //标识项目的作者。
• @borrows //这个对象使用了另一个对象的东西。
• @class //使用下面的文字来描述整个类。
• @constant //将对象记录为常量。
• @constructor //此函数旨在使用“new”关键字调用。
• @constructs //这个函数成员将成为前一个类的构造函数。
• @default //记录默认值。
• @deprecated //记录这不再是首选方式。
• @description //描述一个符号。
• @extends //类型对象继承自.
• @field //一个字段。
• @fileoverview //描述一个文件。
• @function //一个函数。
• @ignore //[todo] 从最终输出中删除它。
• @inner //记录一个内部对象。
• @lends //记录对象字面量的属性，就好像它们属于具有给定名称的符号。
• @link //内联标签 - 创建一个链接。
• @memberof //这个符号属于一个父符号。
• @name //记录一个对象的名称。
• @namespace //记录命名空间对象。
• @param //记录函数的参数。
• @private //这个符号是私有(private)的。
• @property //记录对象的属性。
• @public //这个符号是公开的。
• @requires //这个文件需要一个 JavaScript 模块。
• @return //返回。
• @returns //记录函数的返回值。
• @see //请参阅其他一些文档以获取更多信息。
• @since //这个功能是什么时候添加的？
• @static //记录一个静态成员。
• @syntax //解释语法。
• @throws //描述可能抛出的错误。
• @type //记录对象的类型。
• @version //记录项目的版本号。