您好,欢迎来到爱玩科技网。
搜索
您的当前位置:首页程序开发规范

程序开发规范

来源:爱玩科技网


程序开发规范

Company Document number:WUUT-WUUY-WBBGB-BWYTT-1982GT

1.1. 程序开发规范

1.1.1.目的

定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。

1.1.2.命名规范

Package 的命名

Package 的名字应该都是由一个小写单词组成, 在UCSS项目中,我们对所有的包做如下规定: Class 的命名

Class 的名字必须由大写字母开头而其他字母都小写的单词组成,最好用有意义的单词命名。

如:class GetTreeInfo,class TransToXml等。 Class 变量的命名

类对象的名字必须用一个小写字母开头。后面的单词用大写字母开头。 数据类型的变量第一个字母为变量类型的缩写。如:sPassword,iCount。 关于数据类型标识的说明(弱化该要求,尽量保持)

数据类型 整型(int) 字符串型(String) 浮点型(double) 长整型(long) StringBuffer 数据类型标识 i s d l sb 数据类型 浮点型(float) 字符型(char) 布尔型(boolean) 数组(Array) 二维数组 数据类型标识 f c b a aa Static Final 变量的命名

Static Final 变量的名字应该都大写,并且指出完整含义。

如:private static final int SERVER_PORT=7100; ava) 文件都必须遵守如下的样式规则。 版权信息

版权信息必须在 java 文件的开头,比如: /**

* Copyright 2001 WholeWise Sci.&.,Ltd * All right reserved.

* MODIFIED (YYYY-MM-DD) *developer 2000-01-01 created *changer 2000-02-01 modified */

其他不需要出现在 javadoc 的信息也可以包含在这里。 Package/Import

package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。 package import .*; import;

这里 .* 使用来代替InputStream and OutputStream 的。

如果你能确定你要调用包中的哪一个类,指明具体的类会更好。 如:

import . InputStream; import . OutputStream; import ;

这样运行速度会更快些,查错也方便。 Class

接下来的是类的注释,一般是用来解释类的。 /**

* 描述这个类的功能 */

接下来是类定义,

public class CounterSet extends Observable implements Cloneable; Class Fields

接下来是类的成员变量: protected int iSize;

public 的成员变量必须生成文档(JavaDoc)。proceted、private和 package 定义的成员变量如果名字含义明确的话,可以没有注释。 构造函数

接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。 Public SetSize(int iSize){ = iSize; } 存取方法

接下来是类变量的存取的方法。如果它只是简单的用来将类的变量赋值获取值的话,可以简单的写在一行上。

public int[] getPackets() { return copyArray(packets, offset); } public int[] getBytes() { return copyArray(bytes, offset); } public int[] getPackets() { return aPackets; }

public void setPackets(int[] aPackets) { = aPackets; } 其它的方法不要写在一行上 类方法

下面开始写类的方法:

/** * */

protected final String displayTreeInfo(String sNode) { }

方法的注释

对于方法注释,一般情况下是对一些重要的方法(如接口方法)、复杂或困难的方法加以注释,内容包括:方法名、功能描述、输入、输出、返回值、注意事项等内容。如:

/**

* 功能描述: 根据输入的节点显示其相关的信息

* @param String sNode 节点值

* @return 信息内容

*/

因篇幅问题不能全部显示,请点此查看更多更全内容

Copyright © 2019- aiwanbo.com 版权所有 赣ICP备2024042808号-3

违法及侵权请联系:TEL:199 18 7713 E-MAIL:2724546146@qq.com

本站由北京市万商天勤律师事务所王兴未律师提供法律服务