不当的:
<?php
echo "Here's my code!";
?>
适当的:
<?php
echo "Here's my code!";
/* End of file myfile.php */
/* Location: ./system/modules/mymodule/myfile.php */
不当的:
class superclass
class SuperClass
适当的:
class Super_class
不当的:
function fileproperties() // 方法名没有清晰的描述以及下划线分割单词
function fileProperties() // 方法名没有清晰的描述以及使用了驼峰法命名
function getfileproperties() // 还可以!但是忘记了下划线分割单词
function getFileProperties() // 使用了驼峰法命名
function get_the_file_properties_from_the_file() // 方法名太冗长
适当的:
function get_file_properties() // 清晰的方法名描述，下划线分割单词，全部使用小写字母
不当的:
$j = 'foo'; // 单字符变量应该只作为for()的循环变量使用
$Str // 使用了大写字母
$bufferedText // 使用了驼峰命名，而且变量名应该更短，并有清晰的语法含义
$groupid // 多个词组，应该使用下划线分割
$name_of_last_city_used // 太长了
适当的:
for ($j = 0; $j < 10; $j++)
$str $buffer $group_id $last_city
使用行注释时，在大的注释块和代码间留一个空行。
不当的:
myConstant // 未使用下划线分割单词，未全部使用大写字母
N // 不能使用单个字母作为常量
S_C_VER // 常量名没有清晰的含义
$str = str_replace('{foo}', 'bar', $str); // should use LD and RD constants
恰当的:
MY_CONSTANT
NEWLINE SUPER_CLASS_VERSION
$str = str_replace(LD.'foo'.RD, 'bar', $str);
不当的:
if ($foo == true) $bar = false;
function foo($bar = null)
恰当的:
if ($foo == TRUE)
$bar = FALSE;
function foo($bar = NULL)
不当的:
if ($foo || $bar)
if ($foo AND $bar) // 可以，但有时不被常用的语法程序高亮标识)
if (!$foo)
if (! is_array($foo))
恰当的:
if ($foo OR $bar)
if ($foo && $bar) // 推荐 if ( ! $foo) if ( ! is_array($foo))
不当的:
// 如果 'foo' 位于此字符串的起始处，strpos将返回 0,
// 此处条件判断的结果为TRUE
if (strpos($str, 'foo') == FALSE)
恰当的:
if (strpos($str, 'foo') === FALSE)
不当的:
function build_string($str = "") {
if ($str == "") // uh-oh! 如果传递的参数是FALSE或者整数0那会怎么样? { }
}
恰当的:
function build_string($str = "") {
if ($str === "") { }
}
<?php // 本例中，PHP开始标记之前和结束标记之后就没有空格 ?>
除非你的附加组件的文档中有特别说明，否则所有代码必须与PHP 5.1以上版本兼容。此外，不要使用那些依赖于非默认安装的库的函数，除非你的代码中包含了该函数不可用时的替代方法，或者你在文档中明确说明了你的附加组件需要某些库。
不当的:
class Email pi.email.php
class Xml ext.xml.php
class Import mod.import.php
恰当的:
class Pre_email pi.pre_email.php
class Pre_xml ext.pre_xml.php
class Pre_import mod.pre_import.php
不当的:
email_addresses // 缺少这两个前缀
pre_email_addresses // 缺少 exp_ 前缀
exp_email_addresses // 缺少唯一前缀
恰当的:
exp_pre_email_addresses
说明： 请注意MySQL对表名的限制是不能多于64个字符。会超出这个限制的那些表名都是不合理的，因此这应该不是问题。例如，下面的这个些表名比最大限制多出一个字符。这很傻，不是吗？ exp_pre_email_addresses_of_registered_users_in_seattle_washington
对于你的附加组件所使用的类应当遵循一个文件一个类的原则，除非这些类是紧密相关的。CodeIgniter的文件中包含多个类的一个例子是数据库类文件，其中包含了DB类和DB_Cache类，还有Magpie插件，其中包含了Magpie和Snoopy类。
在代码中使用tab代替空格。这虽然看起来像是小事，但是使用tab代替空格有利于那些阅读你的代码的开发者在他们各自所使用的应用程序中自定义缩进方式。此外还有一个好处是，使用这种方式保存的文件稍微紧凑一点。
文件必须使用Unix换行符保存。这对于那些在Windows下的开发者来说更为重要，但无论如何，确保你的文本编辑器已经设置为使用Unix换行符来保存文件。
不恰当的:
function foo($bar) {
// ...
}
foreach ($arr as $key => $val) {
// ...
}
if ($foo == $bar) {
// ...
} else {
// ...
}
恰当的:
function foo($bar)
{
// ...
}
foreach ($arr as $key => $val)
{
// ...
}
if ($foo == $bar) {
// ...
}
else
{ // ...
}
不恰当的:
$arr[ $foo ] = 'foo';
正确的:
$arr[$foo] = 'foo'; // 数组键值的方括号内没有空格
不恰当的:
function foo ( $bar ) { }
正确的:
function foo($bar) // 函数声明的圆括号内没有空格 { }
不恰当的:
foreach( $query->result() as $row ) // PHP语法控制结构之后有空格，但不是在圆括号内
正确的: foreach ($query->result() as $row)
不正确:
return "Invalid Selection";
正确的:
return $this->lang->line('invalid_selection');
convert_text() // 公开方法
_convert_text() // 私有方法
不正确的:
<? echo $foo; ?>
<?=$foo?>
正确的: <?php echo $foo; ?>
不正确:
$foo = 'this'; $bar = 'that'; $bat = str_replace($foo, $bar, $bag);
正确:
$foo = 'this';
$bar = 'that';
$bat = str_replace($foo, $bar, $bag);
一直使用单引号除非你需要解析变量，如果需要解析变量请使用大括号。
如果字符串包含单引号的话你可以使用双引号，这样就不用转义了。
不正确:
"My String" // 没有解析变量，不需要使用双引号
"My string $foo" // 解析变量需要使用括号
'SELECT foo FROM bar WHERE baz = 'bag'' // 需要转义单引号''时这样写比较难看，可以使用双引号
正确:
'My String'
"My string {$foo}"
"SELECT foo FROM bar WHERE baz = 'bag'"