我正在使用以下命令创建一个简单的应用程序Kohana https://en.wikipedia.org/wiki/Kohana_(framework)PHP 框架，仅供参考。这是我第一次使用该框架。
在开发类或函数时，我使用 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
}
我这样做对吗？在代码中插入注释有标准吗？
我没有使用“检查变量是否大于零”之类的注释。我只是想知道在代码中添加注释是否是一个好的做法。
与注释的视觉风格无关，但像“检查variable_name是否大于零”这样的注释本身就是一个不好的注释。它所做的只是复制下面一行的信息。代码应该包含变量、函数和其他可以读取以了解发生了什么情况的名称。
除此之外，我认为双斜杠注释类型没有任何问题。
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
