项目代码规范注意事项总结(个人笔记)

作为第一个完整开发的项目,在缺少企业级项目开发经验的情况下,代码规范方面有很多欠缺,犯了不少低级错误。当时在部门大佬耐心的指点下以及自己学习参考阿里巴巴开发手册(Java、Android)后,修正了不少代码规范问题,并且针对该项目进行了一些注意点及快捷方式的简单总结(关于阿里开发手册的学习另外单独整理,这篇文章记录自己实际开发中遇到的一些代码规范注意事项,后续开发中遇到的问题一并更新至本文):

(1)改类名(shift+F6)
(2)给常用的字符串,添加常量字符串
(3)注释注意规范,不要在行尾注释
(4)方法名前的注释,用/** */
(5)无用的import去掉
(6)格式化代码(ctrl+alt+l)
(7)在类前加上author、date、类描述(…干什么的)
参考博客:Intellij IDEA中为创建Java类时添加作者与时间信息
(8)变量命名规范
(9)ctrl+shift+U,变量名全部大写/全部小写
(10)JAVA文件中变量命名,遵循小驼峰原则(eg:mComfortableandConvenient)
(11)TAG优化:
public final String TAG = getClass().getSimpleName();
Log.i(TAG,“添加数据”);
还有Log.i和Log.e等等的区别

(12)编写内容提供者相关内容的时候,数据初始化从MainActivity移动至内容提供者,初始化数据不要写在MainActivity中。

你可能感兴趣的:(项目代码规范注意事项总结(个人笔记))