“Protoss/规范/代码规范”的版本间的差异

来自Blueidea
跳转至: 导航搜索
(创建新页面为 '== 缩进规则与行书写规范 == == 控制结构书写规范 == == 函数调用的书写规范 == == 定义类的书写规范 == == 定义函数的书写规范 == == 数组…')
 
第1行: 第1行:
 +
写在前面:
 +
本规则基于PEAR的代码书写规范,但是又有些许改进,在不同的地方会指出。<br/>
 
== 缩进规则与行书写规范 ==
 
== 缩进规则与行书写规范 ==
 +
所有代码中,均使用4个空格作为缩进标准,不允许使用制表符(tab)。<br/>
 +
这样做的好处是:不管什么系统或者编辑器下看,代码都是整齐的。在使用SVN、CVS等工具或者查看diff时,不会对编码和阅读人员带来困难。<br/>
 +
<br/>
 +
如果你使用的是的Emacs编辑器,请设置“indent-tabs-mode”。<br/>
 +
如果你使用的是大蛇所钟爱的Vim(GVim)的话,请在_vimrc中作如下设置:<br/>
 +
set expandtab<br/>
 +
set shiftwidth=4<br/>
 +
set softtabstop=4<br/>
 +
set tabstop=4<br/>
 +
<br/>
 
== 控制结构书写规范 ==
 
== 控制结构书写规范 ==
 +
Control Structures,多译作控制结构,可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/>
 +
其实说白了就是if, for, while, switch这些啦。<br/>
 +
一般不是很复杂的条件判断写成这样:
 +
<source lang="php">
 +
<?php
 +
if ((condition1) || (condition2)) {
 +
    action1;
 +
} elseif ((condition3) && (condition4)) {
 +
    action2;
 +
} else {
 +
    defaultaction;
 +
}
 +
</source>
 +
注意上面这段代码中,if与“(”之间有个空格,两个条件与符号间有空格。“)”与“{”之间有空格,<b>并且是在同一行</b>。<br/>
 +
else和elseif的前后大括号“}”和“{”都在同一行。<br/>
 +
<br/>
 +
如果是switch的话,写成这样:
 +
<source lang="php">
 +
<?php
 +
switch (condition) {
 +
case 1:
 +
    action1;
 +
    break;
 +
 +
case 2:
 +
    action2;
 +
    break;
 +
 +
default:
 +
    defaultaction;
 +
    break;
 +
}
 +
</source>
 +
注意case和switch的缩进级别是一致的。<br/>
 +
 
== 函数调用的书写规范 ==
 
== 函数调用的书写规范 ==
 
== 定义类的书写规范 ==
 
== 定义类的书写规范 ==

2010-08-17T15:51:58的版本

写在前面: 本规则基于PEAR的代码书写规范,但是又有些许改进,在不同的地方会指出。

缩进规则与行书写规范

所有代码中,均使用4个空格作为缩进标准,不允许使用制表符(tab)。
这样做的好处是:不管什么系统或者编辑器下看,代码都是整齐的。在使用SVN、CVS等工具或者查看diff时,不会对编码和阅读人员带来困难。

如果你使用的是的Emacs编辑器,请设置“indent-tabs-mode”。
如果你使用的是大蛇所钟爱的Vim(GVim)的话,请在_vimrc中作如下设置:
set expandtab
set shiftwidth=4
set softtabstop=4
set tabstop=4

控制结构书写规范

Control Structures,多译作控制结构,可以参考[PHP手册]。
其实说白了就是if, for, while, switch这些啦。
一般不是很复杂的条件判断写成这样:

<?php
if ((condition1) || (condition2)) {
    action1;
} elseif ((condition3) && (condition4)) {
    action2;
} else {
    defaultaction;
}

注意上面这段代码中,if与“(”之间有个空格,两个条件与符号间有空格。“)”与“{”之间有空格,并且是在同一行
else和elseif的前后大括号“}”和“{”都在同一行。

如果是switch的话,写成这样:

<?php
switch (condition) {
case 1:
    action1;
    break;
 
case 2:
    action2;
    break;
 
default:
    defaultaction;
    break;
}

注意case和switch的缩进级别是一致的。

函数调用的书写规范

定义类的书写规范

定义函数的书写规范

数组的书写规范

注释的书写规范

载入文件的书写规范

文件头部注释书写规范

文件的相关规范