文档介绍：项目编码规范
命名规范
Java包、类的命名应尽量采用完整的英文描述符,一般采用小写英文字母,但类名、接口名以及任何非初始单词的第一个字母要大写,不能用完整英文描述的,应以该英文单词的前四个字母或能代表单词意思的缩写代替。具体如下:
尽量使用完整的英文描述符;
采用合适于相关领域的术语
采用大小写混合使名字可读
尽量少用缩写,确有需要的,要能表达其意义;
避免使用长的名字(小于15个字母)
避免使用类似的名字,或者是大小写不同的名字;
避免使用下划线(除静态常量等);
举例如下:
包(packge) 采用完整的英文描述符,应该都是由小写字母组成。对于全局包,域名反转并接上包名。.boyi..
类(Class) 采用完整的英文描述符,所有单词的第一个字母大写。如:User,StuManager
接口(interface) 采用完整的英文描述符说明接口封装,所有单词第一个字母大写。名字后面加上后缀Dao,实体类实现接口加上后缀Impl
类变量:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写。如:userName
参数:同上
获取成员函数:封装字段,被访问时调用get set方法
普通成员函数:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写。
静态常量字段:全部采用大写字母,单词之间用下划线分隔。
循环计数器:通常采用字母I,j,k……………..
数组:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写
(二) 代码注释
良好的注释习惯对于一支程序来说,是其易于解读的关键。也就是说,如果另一个编程人员从未见过这段代码,要在合理的时间内理解代码,需要知道哪些信息。并以此作为注释的依据。因此对于注释来说,需要注意以下几点:
(1)注释应该增加代码的清晰度;
(2)保持注释的简洁;
(3)在写代码之前写注释
(4)注释出为什么做了一些事,而不仅仅是做了什么
使用代码注释的目的:
(1)文字说明代码的作用(即为什么要用编写该代码,而不是如何编写);
(2)确指出该代码的编写思路和逻辑方法;
(3)人们注意到代码中的重要转折点;
(4)使代码的阅读者不必在他们的头脑中仿真运行代码的执行方法.
代码注释原则:
1. 用文字说明代码的作用:简单的重复代码做写什么,.
2. 如果你想违背好的编程原则,请说明为什么:有的时候你可能需要违背好的编程原则,或者使用了某些不正规的方法,.遇到这种情况时,请用内部注释来说明你在做什么和为什么要这样做。技巧性特别高的代码段,一定要加详细的注释,不要让其他开发人员花很长时间来研究一个高技巧但不易理解的程序段。
3. 用注释来说明何时可能出错和为什么出错
4. 在编写代码前进行注释:,,就可以在注释之间编写代码.
5. 在要注释的代码前书写注释:注释一定出现在要注释的程序段前,不要在某段程序后书写对这段程序的注释,先看到注释对程序的理解会有一定帮助。如