JavaScript中代码注释的正确方法是什么？

Question

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

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

我找到了新的ReSharper的6(我写的JS在2010年的VisualStudio)提供了相同的意见,如C#,但仅限于功能体,像/// <param name="overlayElement"></param> .ReSharper没有突出显示JS代码注释.

什么是最好的方式...？

Answer 1

使用//是比/* */因为你可以使用后者取出包含其他注释的整个块.但是,如果要使用自动文档生成工具,则必须使用类似于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
*/

Answer 2

好的做法是用//而不是/* */

原因是因为如果你有*/评论的任何部分(假设你还没有打算结束),它将结束评论.即使*/是在字符串中也会发生这种情况.即"*/"<---这将结束评论,并可能会给你一个语法错误.

注释//以换行符结束,因此您需要//每行注释.