Java 程规范.docVIP

Java 编程规范 Class/Interface/Package/Method命名规范 Class/Interface 必须以大写字母开头, 如: Class MainThread extends Thread Interface LoadOption Package 规定的package层次格式为 com.geasp.项目.具体模块 命名必须全部用,,,,写字母, 可以用”_”作为分割符, 例如: com.geasp.util.*; com.geasp.beans.*; com.geasp.shopping_center.client.*; Operations(方法, 函数) 必须以,,,,写字母开头, 采用大,,,,写混合形式, 并且应足够长以描述它的作用. 而且, Method名应以一个动词起首，如 getUserRight() exitProgram() 对于比较长的单词推荐使用缩略语以使名称的长度合理化. 当使用缩略语时, 要确保它在整个使用程序中的一致性. 如果一会儿使用Cnt, 一会儿使用 Count，将导致不必要的混淆. 常量和变量命名约定 常量 必须全部大写, 如: public static final int MAXVALUE; 变量 以,,,,写字母开头 , 如: int ni; 加数据类型前缀, 如: String strName; 常用数据类型前缀请遵守如下规范: 类型 前缀 例子 常用数据类型 Boolean / Boolean .bl blOK char / Char .ch chRead byte / Byte .b bWrite int / Integer .n nLength Short / Short .s sCount long / Long .l lTotal float / Float .f fSum double / Double .d dSum String .str . strNameArray ArrayList .al .alData Vector .v . vData HashTable . ht . htRecord HashMap . hm . hmRecord Calender . cal , cal 与SQL相关的类 Connection . conn . conn1 Statement . stmt . stmtQuery PreparedStatement . pstmt . pstmtQuery CallableStatement . cstmt . cstmtQuery ResultSet . rs . rsQuery 加变量范围, 成员变量加m_, 如: String m_strName; 请使用标准的英文Name, 如果用缩略语也请统一使用 Java编码规范 三种java注释格式 Comment Type Usage Example Documentation Use 文档格式 文档注释直接写在 interfaces, classes, member functions, fields 的前面 这种注释可以通过javadoc的工具生成文档 /** Customer – A customer is any person or organization that we sell services and products to. @author S.W. Ambler */ C style Use C语言风格 多行注释. 可以用来描述算法等多行的文字 /* This code was commented out by J.T. Kirk on Dec 9, 1997 because it was replaced by the preceding code. Delete it after two years if it is still not applicable. . . . (the source code ) */ Single line Use 单行注释 单行注释 // Apply a 5% discount to all invoices // Feb. of 1995. 对于单行注释要补充的是, 尽量不要把注释写在一行的代码的后面. 否则会破坏程序的结构. 应该是写在程序代码的上方并且和代码左靠齐. javadoc javadoc 是一种文档产生工具, 它可以方便的将源文件中的注释转成标准的java文档. 只要在写注释的时候按照一定标准来写就可以了.下表是javadoc支持的一些标签. 我们会在自己的注释中应用javadoc的一些规范. Tag 标签 Used for 使用对象 Pur