javascript - JavaScript中代码注释的正确方式是什么

Question

Javascript 中代码注释的正确方式是什么——语法与 Java 相同吗？哪些工具实际上会利用这些评论:

  /*
  * Add an element to the group
  * @param {Object}  overlayElement
  * @param {Object} [element2] optional element
  */ 

我发现新的 Resharper 6(我在 VisualStudio 2010 中编写 JS)提供了与 C# 中相同的注释，但仅在函数体内，类似于 /// <param name="overlayElement"></param>
. ReSharper 不会突出显示 JS 代码注释。

去...的最佳方式是什么？

Answer 1

使用 // 比 /* */ 好，因为你可以使用后者取出包含其他注释的整个 block 。但是，如果要使用文档自动生成工具，则必须使用类似javaDoc风格的注释。

这是一个适用于 YUI DOC 的示例(最佳)https://yui.github.io/yuidoc/

/**
* This is a description
* @namespace My.Namespace
* @method myMethodName
* @param {String} some string
* @param {Object} some object
* @return {bool} some bool
*/