php - 使用框架时在 PHP 中注释代码

Question

我正在使用 Kohana 创建一个简单的应用程序PHP 框架，仅供引用。这是我第一次使用该框架。

在开发类或函数时，我使用 DocBlock 评论我的代码。使用框架时我应该如何评论我的代码？我打算编写代码的某些部分，而不是整个 Controller 。

基本上，我使用以下方法:

// 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
}

我做的对吗？在代码中插入注释是否有标准？

我没有使用像“检查变量是否大于零”这样的注释。我只是想知道在代码中添加注释是否是一种好的做法。

Answer 1

与评论的视觉风格无关，但像“检查变量名是否大于零”这样的评论本身就是一个糟糕的评论。它所做的只是复制下面一行中的信息。代码应包含变量、函数和其他可以通过阅读了解发生了什么的名称。

除此之外，我认为双斜杠注释类型没有任何问题。