Question

最近，在javascript中使用评论我遇到了一些关于评论系统的问题。我想评论变量的名称，所以我在声明名称之后把它放在同一行，就像这样：

var wk /* (website key) */ = 1;

现在我认为这是完全有效的并且工作正常，对吧？

过了一会儿之后，我想要注释掉整个代码块，就像这样：

/*

~ more code ~
var wk /* (website key) */ = 1;
~ more code ~

*/

但这不起作用，因为当内部评论关闭时，它会关闭整个评论。这对我来说似乎有些愚蠢。有没有办法在javascript中进行嵌套注释？

Answer 1

您无法嵌套块注释，但您可以执行此操作：

var wk = 1; // website key

或者

// website key
var wk = 1;

看起来不那么尴尬，并且块注释只能用于......好吧，块。一般来说这只是更好的编码风格。

或者，甚至更好，让您的代码自我记录，并根本不需要评论：

var websiteKey = 1;

Answer 2

我最近遇到了一个问题，我在他们的wordpress博客上为朋友写了一些JavaScript。无论如何长话短说，他们使用WYSIWYG编辑器，重新格式化页面源。

所以

<script type="test/javascript">
 $(function() {
     // this is a button click handler
     $('#button').click(function () {
         // did some stuff
     });
 })();
</script>

变成了

<script type="test/javascript">
     $(function() {// this is a button click handler $('#button').click(function() {
             // did some stuff }); })(); </script>

故事的重点是始终了解您的环境和用户的需求，即使在评论时也是如此

Answer 3

这样做：

var wk = 1; //Website Key - Additional Info Here

然后如果您需要对块进行注释，则可以执行

/*
  Comments and stuff go here...
  var wk = 1; //Website Key - Additional Info Here

*/

Answer 4

您永远不会在代码之间添加单行注释。原因是它不够可读，并且在社区中没有被视为最佳实践。
使用多行注释标记/ * ... * /或单行注释来轻松完成注释代码//.

PS ：对于评论我建议避免做神奇的事情。我不鼓励嵌套评论！为了在Javascript中拥有一致的评论风格，请尝试遵循JSDoc之类的模式。在JSdoc中，在对一段代码进行注释时，您可以执行以下操作：

/***
 *
 * @param param1
 */
var aFunction = function(param1) {
};

可读，干净，没有神奇的三重奏。它很棒，因为它还嵌入了某种静态类型检查（我知道JS是动态类型的）。还可以看看这个视频，其中包括将JSDoc集成到Intellij＆amp; amp; Webstorm：Dmitry Jemerov: Static types in JavaScript: what, how and why

Answer 5

避免嵌套块注释。它们在ECMA Script specification被禁止。如果任何口译员现在允许这样做，他们将来可能不会这样做。

从第7.4节开始，

评论可以是单行或多行。多行注释无法嵌套。

Javascript评论练习

5 个答案: