开发规范_JAVA程序编写规范.doc

太极华能java开发技术规范

Java程序开发书写规范

【注意】
每一个在公司使用Java语言从事系统开发工作的新员工必须首先阅读本文件，并在工作中严格按照本文件的说明进行源程序书写。

目录
TOC\o"1-3"\h\zHYPERLINK\l"_Toc9148699"程序开发书写规范 PAGEREF_Toc9148699\h1
HYPERLINK\l"_Toc9148700"1. 文件头部注释 PAGEREF_Toc9148700\h2
HYPERLINK\l"_Toc9148701"2. 类头部注释 PAGEREF_Toc9148701\h3
HYPERLINK\l"_Toc9148702"3. 方法头部注释 PAGEREF_Toc9148702\h4
HYPERLINK\l"_Toc9148703"4. 命名规范 PAGEREF_Toc9148703\h5
HYPERLINK\l"_Toc9148704"5. 示例程序 PAGEREF_Toc9148704\h6
HYPERLINK\l"_Toc9148705"6. 注意事项 PAGEREF_Toc9148705\h8

文件头部注释
说明：在所有程序文件的头部，都应有此注释。
/**文件名：<源文件名称>
*创建人：<中文姓名>
*创建时间：<文件完成时间>
*文件简要说明：<主要完成功能；包含的主要方法，属性及其说明>
*引用时的注意事项：<在使用这个类和文件时的要点）>
*----修改1-------------------------
修改人：<中文>
修改时间：<修改完成时间>
<修改说明：>
*----修改2-------------------------
修改人：<中文>
修改时间：<修改完成时间>
<修改说明：>
…
*----修改3-------------------------
…
*/

格式：

类头部注释
说明：
在类的源程序文件中，都应有此注释。该注释必须位于类定义的上方，导入说明（import语句）的下方
packagecard.basic;

importcard.basic.*;
importjava.sql.*;
……
importcom.portal.telecom.*;

/**
*CMyClass类描述了……
*并且提供了……
HYPERLINK"mailto:*@see"*@see<参考类或相关类的类名>
*
*在使用该类的过程中，需要注意以下方面：……
*
*使用方法如下：……
**/
publicclassCMyClassextendsCObjMyBaseClass
{
privateStringstrSql=""; //程序使用：用于数据库操作……
privateStringmstrObj_Id=""; //对象代号：业务使用……
privateStringmstrObj_Name=""; //对象名称：业务使用
……
……
}
格式：

方法头部注释
说明：在程序文件中所有public方法的头部，都应有此注释。
/**
名称：……
说明：……
[实现的主要流程：……]
[引用注意事项：]
*----修改1-----------------------------------
修改人：(中文)
修改时间：
修改说明：
[相关流程：]
…
*----修改n-----------------------------------
…

*@param
<参数1名称><参数1的详细说明，包括各种取值说明〉
*@param
<参数2名称><参数2的详细说明，包括各种取值说明〉
…
*@return
<返回值名称><详细说明>
…
*@throws
<异常类的完整名称><抛出异常描述>
*@see
<类名的完整名称>#<方法名>
*/
格式：

注：
文中带<>的部分必须填写。
“[]”为可选项，只在必要时填写
其中“/**”“@param”和“@return”等蓝色字体必须按照标准书写
命名规范
类型声明：
类型示例作用域类成员参数普通变量数据库String：NamemstrNamevstrNamestrNamePerson_NameIntmintvintintLongmlngvlnglngDatemdtvdtdtDoublemdblvdbldblObject
及派生类mobjvobjobj－ConnectionmobjConnvobjConnobjConnStatementmobjStmtvobjStmtobjStmtResultSetmobj