JAVA编程规范及代码编写标准

《JAVA编程规范及代码编写标准》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、文档编号产品版本产品名称：共XX页Java编程规范及约定日期：2006・6・28日期：一日期：（供内部使用）拟制：李洪研审核：批准：BNSC版权所有侵权必究目录1成员函数规范41」成员函数的命名41.2成员函数的可见性(Visibility)41.3成员函数的注释和说明(Document)51.3.1成员函数头部的说明51.3.2成员函数的内部注释52属性(ATTRIBUTES/PROPERTIES)规范62.1属性的命名62.2属性的可见性(Visibility)92.3属性的注释和说明(Docu

2、ment)93类(CLASS)规范103」类的命名103.2类白勺可见'性(Visibility)103.3类的注释和说明(Document)113.4类的测试(Testing)114接口(INTERFACE)规范12接口的命名12接口的注释和说明(Document)125包(PACKAGE)规范125」包的命名125.2包的注释和说明(Document)126程序编写规范137代码编写格式137.1{}对13规则1.采用以下两种形式均可，但要求在同一项日中必须统一，建议试用第一种137.2()对1

3、47.3运算符148程序编写注释说明14关键词：JAVA,Class,Interface,Package为了提高源程序的质量和可维护性，最终提高公司软件产品牛产力，我们有必要对公司软件产品的源程序的编写风格作出统一的规范约束。本规范总则的内容包括：成员函数、属性、类、接口、包的命名规范，可见性建议以及注释说明等方面对Java编程作了规范。本规范总则的示例都以Java语言为背景，采用以下的术语描述：★规则：编程时强制必须遵守的原则。★建议：编程时必须加以考虑的原则。★例子：对此规则或建议给出响应的例子

4、。本规范有未尽Z处，请及时指出，加以更新。1成员函数规范1.1成员函数的命名规则1・使用成员函数意义完整的英文描述来命名。例子:getFirstName()。规则2・每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法，但函数名的首字母小写。例子：addNewOrder()o规则3・对于函数(Function)或者方法(Method),采用动词加名词来组成函数名。例子:addNewOrder()。规则4.对于有返回值的成员函数，如果其目的是取得一个值，并且返回值是布尔值，函数名以“is”开头

5、，后接有意义的名词。例子:isPersistent()o规则5•对于有返回值的成员函数，如果其目的是取得一个值，并且返回值是其它值，函数名以“get“开头，后接有意义的名词。例子：getFieldName()o规则6•对于改变屈性值成员两数，两数名以”set”开头，后接有意义的名词。例子:setFieldName()。建议1•如杲函数名超过15个字母，可采用以去掉最后名词中元音字母的方法缩写函数名。例子：getCustomerInformation()可改为getCustomerInfrm()1.2

6、成员函数的可见性(Visibility)为了尽量减少程序的耦合性，在设定成员函数的可见性吋请尽量缩小其范围。建议1.不是必须使用public属性的，请使用protected或友好的(不加限定词)。例子：protectedvoidsetUserName()建议2・不是必须使用protected,请使用private。彳列子：privatevoidcalculateRate()建议3・尽量不使用public的变量，而使用私有变量加成员函数的方式。彳列子：privateintm_iSize();publi

7、cintgetSize();publicvoidsetSize(intiSize);1.3成员函数的注释和说明(Document)1.3」成员函数头部的说明规则1・说明这个成员两数做什么。规则2.说明引用这个成员函数需要传入的参数。规则3・说明引用这个成员函数的返回值。规则4・程序中的注释全部用中文。规则5・说明这个函数可能产生的exception.,以及产生异常的原因，时机。例如：该函数中调用了Integer.parselntO,我们在通常使用中一般不做异常处理，但该操作可能抛出NumberFor

8、matException,我们只碍在函数说明中指出除此之外，还有一些建议希望大家采用：建议1・举例说明这个函数的引用方法。1.3.2成员函数的内部注释规则1・局部变量的说明。例子：intiflag=0;//thetypeiflag,ififlag=0meansSHU//iflag=1meansProtectGroup规则2・控制流程的说明。例子：/*讦iflagiszero,thefirstTabofTabbedPaneisselected.*ififlagisone