1 / 9
文档名称:

藏友汇代码规范文档.doc

格式:doc   大小:41KB   页数:9页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

藏友汇代码规范文档.doc

上传人:260933426 2022/3/16 文件大小:41 KB

下载得到文件列表

藏友汇代码规范文档.doc

相关文档

文档介绍

文档介绍:藏友汇
Android
修订记录
版本
时间
修改(拟制)人
修改说明

20140524
藏友汇
第一版开发手册,主要规范编码
widget自定义封装的控件
注释规范
Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是我们 所说的Javadoc注释,它是用来记录我们代码中的API的。Javadoc注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些 HTML标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。
在每个程序的最开始部分,一般都用Javadoc注释对程序的总体描述以及版权信息,之后在主程序中 可以为每个类、接口、方法、字段添加 Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子中的***@auther和***@version,这些段落将在生成文档中以特定方式显示。
强调代码中任何类,变量,方法都需要进行注释,除非是覆盖的系统方法或者是自动生成的Set和Get方法
Javadoc的注释设置:Window=》Preferences=》Java=》Code Style =》 Code Templates
变量注释:(Fields)
/** 变量描述*/
类注释:(Files、Types)
/**
* ***@Description TODO
* ***@author
* ***@date ${date}
* ***@Copyright: Copyright (c)${year} Shenzhen b3a4a Technology Co., Ltd. Inc. All rights reserved.
*/
方法注释:(Constructors、Methods、Methods 、Overriding Methods、Delegate Methods)
/**
* (此处输入方法执行任务.)
*
* ***@version
* ***@createTime ${date},${time}
* ***@updateTime ${date},${time}
* ***@createAuthor
* ***@updateAuthor
* ***@updateInfo (此处输入修改内容,若无修改可不写.)
* ${tags}
*/
异常处理
不能忽视异常处理
catch后的异常需作出合理的处理,若为公用的方法需要不同的处理则抛出改异常到方法外。
不能偷懒而捕捉一般异常
捕捉Exception异常,大小通吃是不对的,这样会让你在错误出现时难以定位到错误原因,一般异常无法用统一方法进行异常处理。
图片资源分类
不同解析度的图片资源分放在不同解析度的包里。若横纵向可完全拉伸的图片则放入至统一的通用的文件夹中。
代码复用
发如果是工程中重复使用的代码,必须提取成工具类或者是自定义控件,不允