电力营销pda系统编码规范.doc

++编码规范 (列或字段) : (IF)编写规范 (存储流程、函数和包等) ,80%的花费在于维护,几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护,编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码,如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误。同一项目参与编程的人可能有各自编程的经验和习惯,不同风格的程序代码使维护工作变得复杂和困难。为了提高代码的可读性、系统的稳定性及降低维护和升级的成本,特编写本规范以统一各开发人员的编程工作。。,增加可读性,减少项目组中因为换人而带来的损失。命名一般以简介单词构成。。.,对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。lassThisAClassName{}。后面的单词用大写字母开头userName,,并且指出完整含义。publicstaticfinalStringDB_CONFIG_FILE_PATH="";。:byte[]buffer;而不是:bytebuffer[];,如果可能的话,使用和要赋值的字段一样的名字:setCounter(intsize){=size;}//注释一行/*......*/注释若干行/**......*/注释若干行,并写入javadoc文档,也叫java文档注释注释要简单明了。StringuserName=null;//用户名边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止注释二义性。保持注释与其描述的代码相邻,即注释的就近原则。对代码的注释应放在其上方相邻位置,不可放在下面。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释应放在此域的右方;同一结构中不同域的注释要对齐。变量、常量的注释应放在其上方相邻位置或右方。全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。 在每个源文件的头部要有必要的注释信息,包括:文件名;版本号;作者;生成日期;模块功能描述(如功能、主要算法、内部