大家好,
有理论上的问题。
我正在使用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
}
我做对了吗?在代码中插入注释是否有任何标准?
编辑:
让我解释一下,我没有使用“检查变量是否大于零”之类的注释。我只是想知道将注释放入代码中是否是一种好习惯。
问候,
汤姆
参考方案
评论是骗子!
注释的问题在于,您必须在更新代码时对其进行更新。如果不这样做,最终将得到如下代码:
// sum $a and $b
$x = $a * $a - $b;
因此,记录您的代码的最佳方法是使其清晰可见!我会这样写你的代码:
if ( isPositive(3) ) {
doA();
} else {
doB();
}
if( $result ) {
displayConfirmationMsg();
} else {
displayErrors();
}
这段代码根本不需要注释,因为它很容易理解!
好吧,无论如何,当我不得不写评论(几乎从来没有)时,我会使用//
表示法,但是我认为这并不重要。
顺便看一下bob http://bit.ly/AYqFT叔叔的精彩视频
PHP-将日期插入日期时间字段 - php我已在数据库中使用datetime字段存储日期,使用PHP将“今天的日期”插入该字段的正确方法是什么?干杯, 参考方案 我认为您可以使用php date()函数
PHP getallheaders替代 - php我正在尝试从服务器上的apache切换到nginx。唯一的问题是我在PHP脚本中使用的getallheaders()函数,该函数不适用于Nginx。我已经尝试过用户在getallheaders函数上的php站点上提供的注释,但这并不返回所有请求标头。请告诉我如何解决这个问题。我真的想切换到Nginx。 参考方案 您仍然可以使用它,但是您必须像这里一样重新定义…
php Singleton类实例将在多个会话中保留吗? - php举一个简单的例子,如果我想计算一个不使用磁盘存储的脚本的命中次数,我可以使用静态类成员来执行此操作吗?用户1:<?php $test = Example::singleton(); $test->visits++; ?> 用户2:<?php $test = Example::singleton(); $test->visits+…
更改默认的URL PHP - php如何更改默认网址。例如www.example.com/index.php-> www.example.com现在,我要将其设置为www.example.com/test.php。我应该在php.ini中进行更改吗? 参考方案 假设您正在使用apache,则可以通过DirectoryIndex指令执行此操作。Check out the docs。
PHP:将字符串拆分为字母和数字部分的最佳方法 - php我有几个格式的字符串AA11 AAAAAA1111111 AA1111111 分离字符串的字母和数字部分的最佳方法(最有效)? 参考方案 如果它们都是一系列字母,然后是一系列数字,并且没有非字母数字字符,那么sscanf()可能比regexp更有效$example = 'AAA11111'; list($alpha,$numeric) =…