Freeiris编码规范要求以可理解的方式来编写Freeiris相关代码。
这样做的目的是易于维护现有代码和开发新代码。
任何新开发功能都需要遵守本编码规范,所以在你提交代码给我们之前,先看看你是否符合此规范。
所有的代码,文件名,函数名,注释(部分可以使用中文,但是必须同时存在英文)必须使用英文.
不要简单的只写上” /* Lee 2010-3-19 */ “作为注释内容,注释内容要包括这个代码干了什么,为什么要这么改,如果有必要要对应mantis中响应的ID号.
注释根据语言不同可以选择使用所支持的注释方式.
如果还是搞不清楚,先看看其他人怎么写的自己再写代码.
请使用四个空格来替代tab键的作用.
不要用拼音来作为变量名称
不要使用aa,bb,ccc这类毫无意义的变量
变量可以是单字母,字母加数字,或中间有_的变量
代码以块形式{}存在. 在块之中的内容要缩进
不同功能的代码尽量分离开不要过于紧凑,不同功能之间要有注释
要使用c java php perl通用的语法, 不要使用奇异的语法,尤其是perl中
缩进要使用四个空格来替代Tab
if for while等流程判断块的在语法后要跟一个空格,不要紧贴在一起写
禁止使用标签或GOTO除非他们是不可替代的
如果给变量起名字的时候怕与其他变量冲突可以以prefix形式来声明局部变量.
如果是全局变量或特殊变量可以以大写字母或GLOBALS_或FREEIRIS2_或XXX_
被认可的:
for ($a=aa;$a<=10;$a++) {
}
不被认可的:
for($a = aa; $a<=10; $a++) {
}
被认可的:
if (foo) {
bar();
} else {
blah();
}
不被认可的:
if (foo) {
bar();
} else {
blah();
}
不被认可的:
for (x = 0; x < 5; x++)
if (foo)
if (bar)
baz();
被认可的:
function abc() {
$abc=123;
}
不被认可的:
function abc(){
}
function abc() {
$abc=123;
}
被认可的:
while(1) {
if (...)
{
if (...) {
}
}
}
不被认可的:
while(1) {
if (...)
{
if (...) {
}
}
}
|
FONOIRS公司提供电信级的IP PBX及运营商系统的研发和销售, 同时也是Freeiris2这个全球唯一一款来自中国的开源通信平台的贡献者.
|
|
|
|
|
Freeiris爱好者QQ群 43185599
|