JavaScript中代码注释的正确方式是啥

Posted 2023-02-21

【中文标题】JavaScript中代码注释的正确方式是啥

【英文标题】：What is the correct way of code comments in JavaScriptJavaScript中代码注释的正确方式是什么

【发布时间】：2011-10-12 13:18:33

【问题描述】：

在 javascript 中编码 cmets 的正确方法是什么 - 与 Java 中的语法相同吗？哪些工具实际上会利用这些 cmets：

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

我发现新的 Resharper 6（我在 VisualStudio 2010 中编写 JS）提供与 C# 中相同的 cmets，但仅在函数体中，例如 /// <param name="overlayElement"></param> 。 ReSharper 不会像这样突出显示 JS 代码 cmets。

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

【参考方案1】：

使用// 比使用/* */ 更好，因为这样您就可以使用后者取出包含其他 cmets 的整个块。但是，如果要使用自动文档生成工具，则必须使用类似于 javaDoc 样式的 cmets。

这是一个适用于 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
*/

【讨论】：

所以跟javadoc很像，很高兴知道。感谢所有帮助过的人。

您的代码编辑器应该允许您标记文本并在每一行中用 // 将其取出（例如 Ctrl + /）。无论那里有什么，它都会注释掉所有内容。

【参考方案2】：

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

这样做的原因是因为如果您在评论的任何部分有*/（假设您还不打算结束），它将结束评论。即使*/ 在字符串中也会发生这种情况。即"*/"

注意// 以换行符结束，因此每行注释都需要//。

【讨论】：

注意：Ctrl-K、Ctrl-C 和 Ctrl-K、Ctrl-U 是注释和取消注释代码的便捷快捷键。

我不同意并更喜欢 /* */ always.. 缩小器.. 以及它总是派上用场的许多原因。

【参考方案3】：

一个很好的例子是仍然基于 Java 的注释，它也与 JSDoc 一起使用。您可以在此处找到示例：http://code.google.com/p/jsdoc-toolkit/wiki/FAQ

要将简单的在线人添加为 cmets，// 仍然是注释代码的好方法。但是为了生成文档，我会使用 JSDoc 语法。我过去用过它，效果很好。