程序书写规范.doc

《程序书写规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、1.程序书写1.1.程序书写风格1.1.1.培养良好的程序风格良好的程序书写风格将有助于提高软件的质量和效率。程序书写风格在以下方面体现：常量、变量的使用；注释的使用；变量、属性及方法的命名；语句的书写与使用地点。以下建议将有助于培养良好的程序书写风格：l多阅读他人程序，包括阅读厂商提供的源程序，学习优点；l从程序错误中吸取教训，不再犯同样错误；l程序书写过程中，牢记有关要求，不怕麻烦。1.1.2.程序书写规范以下给出程序书写有关规范：l程序必须使用逐层缩进的格式；l程序中必须有注释(有关注释使用规范在随后章节中单独说明)；l建议分

2、行书写复杂表达式和复杂语句；l方法中的程序段不宜过长；l除在极为特殊的情况下，禁止使用系统或其它软件开发包提供的未公开的函数调用。1.2.注释注释的使用遵循以下规范：l要求使用注释在程序开头说明本程序的实现功能，建议用注释标明程序作者和时间，以及需要说明的其它事项；l较多的常量定义和属性定义处，要求用注释说明变量和属性的情况；l如果对别人的程序进行修改，必须在主要的修改处用注释说明所作的修改，并标明修改者；l要求用注释说明方法的功能、参数、异常以及返回值，有多个返回值时应说明不同返回值的值、及返回值意义；l同一程序段中进行不同的操作

3、时，要求用注释说明一组程序的功能；l大段改动程序时，建议用注释屏蔽旧的程序段，以避免修改时增加新错误，避免可能的程序恢复。2.Java命名规则2.1.命名综述命名包括对程序中文件、变量、属性、方法等程序对象的命名。好的命名风格将有助于提高程序可读性，并易于修改和维护，从而减少错误，提高编程效率。除简单使用的变量(如用于循环计数的变量)外，变量的名称必须有意义，以便于识别该对象；但不宜过长，以避免使用中键入时出错。软件的最终发布性文件，包括最终的可执行程序、动态链接库、帮助文件等文件的命名，由项目负责人统一确定。软件的最终使用性名称，

4、包括整个软件的名称及单个模块的名称，包括安装后的菜单项及快捷方式的名称，由项目负责人统一确定。整个软件的大名称由公司经理确认。1.1.Java命名规范1.1.1.Java程序命名规则●Java包的命名包名的所有单词均为小写。如：business、housemanager。Ex:正确：packagecom.capinfo.util;错误：packagecom.CAPINFO.util●Java类的命名类名+所属类型，类名要体现出该界面类的主要功能，类名中的所有单词的打头字母为大写，如：HouseControl、DBControl、Co

5、mputeFrame。Ex:正确：SomethingHandler.java;SomethingProxy.java,SomethingDAO.java错误：somethinghandler.java;somethingProxy.java,Somethingdao.java●Java方法的命名方法的命名要体现出此方法的作用。方法名的第一个单词的打头字母要小写，其后单词打头字母为大写。如：drawPicture()、getHouse()。Ex:正确：publicvoidchangePassword()错误：publicvoidcha

6、ngepassword()●Java变量的命名变量名的第一个单词的打头字母要小写，其后单词打头字母为大写。变量的命名应该体现该变量代表的含义。该规则既适用于类的属性，也适用于方法中的变量和方法使用的参数。Ex:正确：StringapplicationName;publicvoidvalidateUser(intuserId,Stringpassword)错误：Stringapplicationname;publicvoidvalidateUser(intUserId,Strings)●Java常量的命名这里常量指的是类型为stati

7、cfinal的变量。常量全部以大写字母书写，如超过一个单词，则应采用“_”链接，单词可使用缩写。如：PI、HOUSE_TYPEEx:正确：staticfinalStringSYSTEM_ADMIN_USER=“admin”;错误：staticfinalStringSYSTEMADMINUSER=“admin”;●Java文件名的命名文件名必须与类名相同，遵守和类名相同的规则。●Java数组的命名数组的方括号应该在变量前面，而不是后面。Ex:正确：byte[]buffer;错误：bytebuffer[];1.Java注释规则1.1.注

8、释规则综述Java程序有两类注释：实现注释(implementationcomments)和文档注释(documentcomments)。实现注释是那些使用/*...*/和//界定的注释。文档注释(被称为"doccomments")是