没有合适的资源?快使用搜索试试~ 我知道了~
享兼职移动APP-3期(AL028) AL028040100001 编码规范书.doc
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 8 浏览量
2022-07-13
16:18:53
上传
评论
收藏 141KB DOC 举报
温馨提示
试读
16页
享兼职移动APP-3期(AL028) AL028040100001 编码规范书.doc 学习资料 复习资料 教学资源
资源推荐
资源详情
资源评论
代码要求
序号
要求
备注
1
有详尽的编码规范书,应包括
(1) 注释规范
(2) 书写规范(缩进换行,括号,关键字,控制语句)
(3) 命名规范(变量,函数,类名,常量,文件名等)
2
有详细的文件目录说明文档,具体说明每个代码文件的作用
3
代码整齐有序,符合第 1 项的编码规范
4
每个文件开头,有详细文件功能注释
5
每个函数前有详细的函数输入/输出/功能的注释
6
每个功能段代码有详细的代码注释
一、 文件
(一) 文件命名
文件名遵从 Java 命名法,以其最顶层的类名来命名,大小写敏感,无特殊情况,扩展名小写。
源文件使用文件扩展名为:.java。
资源文件使用文件扩展名为:.xml。
文件编码格式为 UTF-8。
根据不同的文件类,命名方法如下:
文件类型
文件名称
源文件
XXX.java
资源文件
XXX.xml
(二) 文件注释
在每个文件头必须包含以下注释说明
/*----------------------------------------------------------------
// Copyright (C) 2004 XXXXX 公司
// 版权所有。
//
// 文件名:
// 文件功能描述:
//
//
// 创建标识:
//
// 修改标识:
// 修改描述:
//
// 修改标识:
// 修改描述:
//----------------------------------------------------------------*/
文件功能描述只需简述,具体详情在类的注释中描述。
创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如:李轶 20040408
一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。
二、 代码外观
(一) 列宽
一个项目可以选择一行 80 个字符或 100 个字符的列限制,除了下述例外,任何一行如果超过这个字
符数限制,必须自动换行。
例外:
不可能满足列限制的行(例如:Javadoc 中的一个长 URL,或是一个长的 JSNI 方法)。
注释中那些可能被剪切并粘贴到 shell 中的命令行。
(二) 换行
当表达式超出或即将超出规定的列宽,遵循以下规则进行换行:
1、在逗号后换行。
2、在操作符前换行。
3、规则 1 优先于规则 2。
4、当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
(三) 缩进
自动换行时,第一行后的每一行至少比第一行多缩进 8 个空格(注意:制表符不用于缩进)。当存在连
续自动换行时,缩进可能会多缩进不只 8 个空格(语法元素存在多级时)。一般而言,两个连续行使用相同
的缩进当且仅当它们开始于同级语法元素。
(四) 空行
空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。
在以下情况下使用一个空行
1、类内连续的成员之间:字段,构造函数,方法,嵌套类,静态初始化块,实例初始化块。
2、在函数体内,语句的逻辑分组间使用空行。
3、类内的第一个成员前或最后一个成员后的空行是可选的。
4、多个连续的空行是允许的,但没有必要这样做。
(五) 空格
除了语言需求和其它规则,并且除了文字,注释和 Javadoc 用到单个空格,单个 ASCII 空格也出现在
以下几个地方:
1、分隔任何保留字与紧随其后的左括号(()(如 if, for catch 等)。
2、分隔任何保留字与其前面的右大括号(})(如 else, catch)。
3、在任何左大括号前({),两个例外:
(1)@SomeAnnotation({a, b})(不使用空格)。
(2)String[][] x = foo;(大括号间没有空格)。
4、在任何二元或三元运算符的两侧。这也适用于以下”类运算符”符号:
(1)类型界限中的&()。
(2)catch 块中的管道符号(catch (FooException | BarException e)。
(3)foreach 语句中的分号。
5、在, : ;及右括号())后。
6、如果在一条语句后做注释,则双斜杠(//)两边都要空格。这里可以允许多个空格,但没有必要。
7、类型和变量之间。如:List list。
8、数组初始化中,大括号内的空格是可选的,即 new int[] {5, 6}和 new int[] { 5, 6 }都是可以的。
(六) 括号
1、用小括号来限定组。
2、除非作者和 reviewer 都认为去掉小括号也不会使代码被误解,或是去掉小括号能让代码更易于阅
读,否则我们不应该去掉小括号。
3、 没有必要的话不要在返回语句中使用(),如:
if (condition)
Array.Remove(1);
return 1;
(七) 花括号
1、左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如
if (condition)
{
}
public int Add(int x, int y)
{
}
2、左花括号“{”要与相应的右花括号“}”对齐。
3、通常情况下左花括号“{”单独成行,不与任何语句并列一行。
4、if、while、do 语句后一定要使用{},即使{}号中为空或只有一条语句。如
if (somevalue == 1)
{
somevalue = 2;
}
5、右花括号“}”后建议加一个注释以便于方便的找到与之相应的“{”,如
while (1)
{
if (valid)
{
} // if valid
else
{
} // not valid
} // end forever
三、 程序注释
(一) 注释概述
1、修改代码时,总是使代码周围的注释保持最新。
剩余15页未读,继续阅读
资源评论
努力搬砖的小王
- 粉丝: 16
- 资源: 7706
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功