PHP:注释代码
大家好，
有理论上的问题。
我正在使用KohanaPHP框架创建一个简单的应用程序，仅供参考。这是我第一次使用框架，并且有一个问题--对你们中的一些人来说可能很愚蠢--问题。
在开发类或函数时，我使用DocBlock对代码进行注释。只是想知道在使用框架时，我应该如何注释我的代码？我的意思是编写部分代码，而不是整个控制器。
基本上，我使用了以下方法：
// Check if variable_name is greater than zero
if($this->var > 0) {
// do something
} else {
// do something
}
if( $result ) {
// display confirmation message
} else {
// display errors
}我这样做是对的吗？在代码中插入注释有什么标准吗？
编辑:让我解释一下，我没有使用像“检查变量是否大于零”这样的注释。我想知道在代码中加入注释是不是一种好的做法。
问候你，汤姆
回答 6
Stack Overflow用户
发布于 2010-08-12 03:52:29
注释是骗子！注释的问题是你必须在更新代码的同时更新它们。如果你不这样做，你最终会得到这样的代码：
// sum $a and $b
$x = $a * $a - $b;所以，记录你的代码的最好方法就是让它变得非常清晰！我会这样写你的代码：
if ( isPositive(3) ) {
doA();
} else {
doB();
}
if( $result ) {
displayConfirmationMsg();
} else {
displayErrors();
}这段代码根本不需要注释，因为它很容易理解！
好吧，不管怎样，当我必须写注释时(几乎从不)，我会使用//表示法，但我认为这并不重要。
顺便说一下，看看这个bob http://bit.ly/AYqFT叔叔的视频。
Stack Overflow用户
发布于 2010-08-12 03:40:58
与评论的视觉风格无关，但像“检查variable_name是否大于零”这样的评论本身就是一个糟糕的评论。它所做的就是复制下面这行中的信息。代码应该包含变量、函数和其他内容的名称，这些名称可以读取以了解发生了什么。
除此之外，我认为双斜杠-注释类型没有任何问题。
Stack Overflow用户
发布于 2010-08-12 03:40:41
// Check if variable_name is greater than zero这样的评论是没有价值的。我对PHP知之甚少，即使我对此一无所知，但只要看了这行代码，我就可以立即断定(或者至少可以非常自信地猜测)。
作为一个通用的(语言不可知的)经验法则，编写主要是自我文档化的代码(通过使用描述性的名称，避免不明显的快捷方式等)，并且只注释你为什么要做看起来错误/奇怪的事情。
https://stackoverflow.com/questions/3462103
复制相似问题
腾讯云开发者
