你的方式来写简单的评论

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

我主要是编写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); 

你是怎么做到的？

---

(*
 * 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- /是你的朋友;-)

---

一种简单的方法来改善JavaScript中的评论/分解块，这在编程时非常简单快捷。

当你想在javascript中创建注释块时，你需要添加这个众所周知的方式：

/*
...
*/

所以，当你需要分解时，你需要改变开始/ *和结束* /，但我用这样的：

/*
...
//*/

通过这种方式，将开始/ *改为// *，您将分解整个块，只添加一个字符，而不需要搜索注释的结尾。

链接地址: http://www.djcxy.com/p/14939.html

上一篇: Your way to write simple comments

下一篇: What is the preferred way of notating methods in comments?