0

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

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

你是怎么做到的？

4

2 回答 2

2

改进 javascript 中的注释/注释块的一种简单方法，它在编程时非常容易和快速。

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

/*
...
*/

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

/*
...
//*/

这样，将开头的 /* 更改为 //* 您将取消整个块的注释，只添加一个字符，而无需搜索注释的结尾。

于 2013-02-21T22:29:04.107 回答
0 
(*
 * 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-/ 是你的朋友 ;-)

于 2012-06-27T11:58:31.853 回答