Question

你们如何在一些你自己使用的简单代码上写评论？

我主要编写JavaScript和PHP代码，我真的觉得我找不到写评论的好方法。

如果我有一小段代码，我通常会这样做：

x = doThis(getSomeValueFromSomewhere());  // This is a short line of code

我觉得这看起来真的很不错，但是当线条变长或多行时，它确实不起作用，

 // Dont really like this since it's not clear if it describes only line 1, or all lines.
 aLongerVariableName = (getSomeValueFromSomewhere() == "this is what I want") ? "true value" : "false value";
 x = doThis(aLongerVariableName);

那么，你是怎么做到的？

Answer 1

一种改进javascript中注释/退出块的简单方法，在编程时非常简单快捷。

如果你想在javascript中创建一个评论块，你需要添加这个众所周知的方法：

/*
...
*/

所以，当你需要退化时，你需要改变开头/ *和结束* /，但我这样使用：

/*
...
//*/

这样就可以将开头/ *更改为// *，您将对整个块进行解除注释，只需添加一个字符，而无需搜索注释的结尾。

Answer 2

(*
 * For blocks of comments that serve as important documentation
 * e.g descriptions of functions.
 *)

可能会重新格式化为

 (* For blocks of comments thet serve as important documentation
  * e.g descriptions of functions. *)

对于像你这样的简短内联评论// 不要忘记Ctrl- /是你的朋友; - ）

你写简单评论的方法

2 个答案: