《java代码书写规范》由会员分享，可在线阅读，更多相关《java代码书写规范（17页珍藏版）》请在金锄头文库上搜索。
1、 符号命名规则符号命名规则符号名包括：模块名，变量名，常量名，方法（函数/子程序）名,数据区名,缓冲区名等。符号命名通常应遵循以下规则：通用规则：1、在所有命名中，都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写，除非该名字描述的是中文特有的内容，如半角、全角, 声母、韵母等。 2、所有命名都应遵循达意原则，即名称应含义清晰、明确。 3、所有命名都不易过长，应控制在规定的最大长度以内。 4、所有命名都应尽量使用全称。 5、如果命名使用缩写，则必须对其进行注释和说明。 具体规范： 1、工程名、工程名 统一制订。 2、文件名、文件名文件名应与类名相同，这是 java 的规范3、方法名、方法名/
2、函数名函数名方法名第一个单词小写。推荐使用动宾结构。方法名应清晰反映该方法的功能、用途。方法名最长不得超过 30 个字符。例：getCollection();setCollection();insertObject();deleteObject();3、变量名、变量名必须使用有意义的变量名。推荐的类型缩写（type）char：chboolean：bint：ilong：ldouble：dfloat：f 变量名最长不得超过 20 个字符。 4、类名、类名必须以大写字母开头，类名反映具体含义，以清晰表达类的用途和功能为原则当名称由多个单词构成时，每一个单词的第一个字母必须大写 代码书写规范代码书写规
3、范 书写规范即在编写代码过程中所使用的标准格式， 主要包括空格的使用、括号的使用、缩近格式和其他一些内容。源代码书写规范源代码书写规范1在.java/.jsp 的开头应有一段格式统一的说明，内容包括： a. 文件名 (Title/FileName)； b. 创建人 (Author)； c. 文件创建时间 (Date)； d. 简短说明文件功能、用途 (Description /Function)。 样例：/* 标题:Schedule.java* 描述:用来实现计划项目审批* 创建:2001-06-30* 作者:赵文正* 详细：详细描述计划项目审批的细节,如何根据细节功能确定方法*/2. 除非极
4、其简单，否则对函数应有注释说明。内容包括：功能、入口/出口参数，必要时还可有备注或补充说明。 3. 每行代码的长度推荐为 80 列，最长不得超过 120 列；折行以对齐为准。 4. 在类的成员函数内调用其他类的成员函数时，其他类的成员函数可做简短说明。 6. 函数入口参数有缺省值时，应注释说明。 例: float getValue(int ID, boolean flag) /* parameter description ID: Identify Noflag : default = TRUE */ 7. else if 必须写在一行。 8. 与、 有关的各项规定： 、 应独占一行。在该行内
5、可有注释。 例：正确： for (i = 0; i 0) m = 1;n+; 不得写做： if (i 0) m = 1;n+; 在循环、分支之后若只有一行代码，虽然可省略、 ，但不推荐这么做。若省略后可能 引起歧义，则必须加上、 。例：正确： if (n = -2) n = 1; else if (n != nTemp) n = 2; else n = 3; 不得写做： if (n = -2) n = 1; else if (n != nTemp) n = 2; else n = 3;9. 与空格有关的各项规定。 所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在 .、 、
6、 等运算符前后，及 for (int i = nMinLine; i 进行分段。注释的检查工具注释的检查工具SUN 提供 DocCheck 工具，用来检查注释风格和标记的错误，并能提供修改建议。描述部分描述部分描述部分第一句应该是关于该类，接口，包，成员的概括，Javadoc 工具将会 copy 这一句作为该部分的概括。例：/* This is a simulation of Prof. Knuths MIX computer.*/Javadoc 会抽取到 Prof 为止，作为概述。不过可以通过 HTML 标记 “ * false otherwise.* see Image* see Imag
7、eObserver* since JDK1.0*/public abstract boolean drawImage(Image img, int x, int y, ImageObserver observer);/* Dispose of the system resources used by this graphics context.* The Graphics context cannot be used after being disposed of.* While the finalization process of the garbage collector will* a
8、lso dispose of the same system resources, due to the number* of Graphics objects that can be created in short time frames* it is preferable to manually free the associated resources* using this method rather than to rely on a finalization* process which may not happen for a long period of time.* * G
9、raphics objects which are provided as arguments to the paint* and update methods of Components are automatically disposed* by the system when those methods return. Programmers should,* for efficiency, call the dispose method when finished using* a Graphics object only if it was created directly from
10、 a* Component or another Graphics object.* see #create* see #finalize* see Component#getGraphics* see Component#paint* see Component#update* since JDK1.0*/public abstract void dispose();/* Disposes of this graphics context once it is no longer referenced.* see #dispose* since JDK1.0*/public void finalize() dispose();
