文档介绍：Android JAVA开发代码与注释规范
说明:
1本代码规范如有不合理的地方可以提出进行修改,对于规范有建议可以提出添加,该规范只是个初版,后期可以进行完善并执行。
2本规范旨在提高代码可读性,让接手项目的人可以节省代码阅读时间成本。最终主旨可以做到,让小白程序猿都可以看清代码逻辑
1代码规范
缩进风格
程序块要采用缩进风格编写,缩进的空格数为4个。说明:对于由开发工具自动生成的代码可以有不一致。
分界符’{’和’}’
应与所修改文件或新建文件所在的工程或模块保持一致。分界符’{’和’}’独占一列,与引用它们的语句左对齐,并且不允许空行。(虽然Android中要求分界符’{’不独占一行,但是个人认为分界符独占一行会更有助于代码结构的整理,可以单独区分模块)在函数体的开始、类和借口的定义、以及if、for、do、switch、case语句中的程序都要采用如上的缩进风格
示例:不符合规范
for(…)
{
…//program code
}
void example_fun(void)
{
…//program code
}
符合规范
for(…)
{
…//program code
}
void example_fun(void)
{
…//program code
}
较长的语句、表达式参数
较长的语句、表达式活着参数(>100字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读
示例:
if (datas!=null
&&<xxxxxxx)
public static void read (String s1,String s2,String s3
String s4,String s5,String s6)
不允许把多个短语句写在一行中,即一行只允许写一条语句
示例:不规范代码:
String s1=“”;String s2=“”;
应书写如下
String s1=“”;
String s2=“”;
if,for,do,while,case,switch,default 等语句自占一行,且无论执行语句有多少都要加括号{}。
示例:不规范代码
if(true) return;
应书写如下:
if (true)
{
return;
}
相对独立的程序块之间、变量说明之后必须加空行。
示例:不规范代码:
if (true)
{
return
}
String s1;
应书写如下:
if (true)
{
return
}
String s1;
对齐只使用空格,不使用TAB键。(TAB键长度为4个空格)
说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐。
关键字、变量、常量进行对等操作
在两个以上的关键字、变量、常量进行操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后面不加空格。
说明:采用这种方式编写代码的目的是为了使代码更加清晰。由于留空格所产生的清晰性是相对的,所以在非常清晰的语句中没有必要留空格。
示例:
(1)逗号、分号只在后面加空格。
String a, b, c;
(2)比较操作符“>=”、“==”,赋值操作符“=”、“+=”,算数操作符“+”、“%”,逻辑操作符“&&”,位域操作符“<<”的前后加空格。
if (a >= b)
a = b + c;
a += 2;
a = b + 2;
(3)地址运算符“!”、“++”、“&”等操作符前后不加空格
bool = !true;
i++;
(4)if、for、while、switch等后面的括号间应加空格,可以使关键字更为突出
if (true)
(5) 一行程序的长度不宜过长,以小于80个字符为宜
2注释
,源代码的有效注释量必须在20%以上
说明:注释的原则是有助于对程序的阅读理解,在改加的地方都加,尽量做到明确,易懂,简洁。
类说明性注释
说明:在每个类的头部,都应该列出生成时间,作者,功能,修改历史
修改历史在每次对该类进行修改的时候进行添加
示例:
/**
* 生成时间:2017-09-10
* 作者:wyj
* 功能:这是一个界面
* 生成版本号:
* 修改历史:
* 作者,版本,新增功能,新增时间(这里尽量用简述)
* (