Java代码规范交流与分享

整理文档很辛苦,赏杯茶钱您下走!

免费阅读已结束,点击下载阅读编辑剩下 ...

阅读已结束,您可以下载文档离线阅读编辑

资源描述

Java代码规范交流与分享分享人:onelong博客:交流对象Java开发人员Android开发人员面向对象软件开发人员交流时长大约1个小时分享内容文件编码规范包名定制规范命名规范注释规范代码排版之美(eclipse示范)Android的额外规范各抒己见为什么需要规范?提高可读性,让代码阅读者心情更好提高可维护性,高效工作心情快乐可使开发组沟通愉快规范是一个团队的约定,故以交流分享为主题。规范应该是快乐的……文件编码规范描述:java文件或者项目统一使用UTF-8Why:可能由于操作系统,文本编辑工具的不同,会导致注释乱码,排版混乱。Linux下面不支持GBK,但是win下默认是GBK。Howtodo:Eclipse演示包名规范描述:包名统一使用小写,而且不使用下划线,一般建议使用企业或者组织的域名的倒序作为包名开头。Why:java中可以使用默认包,但是android开发中必须指定一个唯一主包名,系统就是靠这个包名来区分不同的软件的例如:com.chinachip.android.projectname命名规范-类名类名根据实际功能命名,尽量使用英文,不排除使用中文拼音,但是大部分情况下不建议使用拼音拼写(如Person)类名大写字母开头,如果由多个单词组成,每个单词的第一个字母大写(如PersonAddress)类名不建议使用中文拼音或英文的缩写,尤其是中文拼音的缩写。类是抽象出来的事物,故类名应使用名词性单词或单词组合。命名规范-方法名方法根据实际功能命名,尽量使用英文,不排除使用中文拼音(如getX)方法如果由多个单词组成,第一个单词的字母要小写,其他单词首字母大写。(getUserName)方法名不允许使用中文拼音或英文的缩写。方法是描述一种行为,故方法名应使用动词性单词或单词组合命名规范-常量名常量名必须全部字母大写,多个单词组成时,用下划线(“_”)分隔单词(如EDIT_MENU)。常量必须用final修饰。枚举成员同样遵守该原则命名规范-变量名第一个单词的首字母小写,其后单词的首字母大写。不允许以下划线或美元符号开头变量名除个别为人熟知的缩写(如”num”代表”number”),以及在循环变量中使用I,j,k等简单英文字母以外,其他变量要使用英文单词或者单词组合。int[]getXY;vsint[]point;命名规范-接口和类名基本一致建议以大写字母“I”开头,如IBinderAndroid的回调接口,建议使用XXListener(如DownloadListener)注释规范方法必须有注释注释必须包含:功能,参数,返回等相关说明常量和部分重要的变量建议添加注释示例:eclipse演示快捷键(Ctrl+shift+j,ctrl+/,Ctrl+shift+/,Ctrl+shift+\)代码之美缩进与括号排版,代码大括号的排版风格函数和函数之间必须隔行,函数内部不建议出现隔行!一行长度超过80个字符换行,下一行缩进8个字节。操作符前后应该有空格示例(Window-preferences-java)Android的额外规范android:id=”@+id/yourID”,应该放在每个标签最显眼的地方,一般放在标签之后的第一行和语言相关的字符串应该放到value文件夹下面,方便以后支持多语言定制。各抒己见你心目中的规范应该是怎样的?是什么让我们去忽视了代码的规范呢?你认为规范真的可以为自己带来方便吗?小结交流分享到此结束谢谢!

1 / 22
下载文档,编辑使用

©2015-2020 m.777doc.com 三七文档.

备案号:鲁ICP备2024069028号-1 客服联系 QQ:2149211541

×
保存成功