网络资源收集工具编码规范

1 概述

1.1 编写目的

本文描述了项目开发中的有关包、类、接口、方法、实例变量、变量和常量的命名规则，用于规范本项目编程过程中的命名和代码书写规范。

1.2 预期读者

开发组全体成员。

2 命名规范

2.1 类名、接口命名规则

类和接口的名称应是一个名词，采用大小写混和的方式，所有单词都应紧靠在一起，其中每个单词的首字母应大写。如：

2.2 方法命名规则

方法名应是一个动词或动名结构，采用大小写混和的方式，其中第一个单词的首字母用小写，其后单词的首字母大写。例如：



每个方法前必须加说明包括：参数说明、返回值说明、异常说明。

2.3 变量命名规则

变量命名采用大小写混和的方式，第一个单词的首字母小写，其后单词的首字母大写，变量名一般不要用下划线或美元符号开头。变量名应简短且有意义，即，能够指出其用途。除非是一次性的临时变量，应尽量避免单个字符的变量名。

（1）类的实例对象定义如下：



（2）同一个类的多个对象可以采用一下定义方式：



（3）集合类的实例命名使用集合包含元素的英文名称的复数表示，例如：



（4）数组的声明要用" JMenuItem[] menuitem "的形式，而不要用" JMenuItem menuitem[]"。

2.4 常量命名规则

类常量的命名应全部用大写，单词间用下划线隔开。例如：

3 代码书写规范

除了一些特殊的方法如UI界面的布局构造函数，配置事件监听器动作actionPerformed函数，类的方法的代码行数不能过长，尽量控制在160行以内（90%），必要的时候要合理地拆分成私有函数。

3.1 返回值

在一般情况下，方法返回值不应返回null，如果发现返回值出现null的情况，尽量使用异常代替。

不排除存在必须返回null(比如有些集合类实例是允许null作为键或值)的情况, 须在方法说明中加以特别说明。

3.2 异常

整个应用系统使用异常类继承自Exception，该类包括错误信息和异常类型两部分，该类在创建时是自动获得类名、方法名、行号等信息。

3.3 表达式

1) 所有的算术、逻辑表达式的每一项运算都需要加圆括号，避免使用java语言的运算符优先级。

2) 除去”/”以外的二元算术运算符、二元逻辑元素符、赋值运算符，既“+、-、*、%、+=、-=、*=、/=、%=、>、<、 ==、 >=、<=、 =”等符号左右两边要加空格。

3) 变量声明已经参数说明部分的逗号”,”之前不需要留空格，之后需要留空格。如：

3.4 体前代码

体前代码包括：

a) 方法的参数说明和异常说明；

b) 条件语句，如if语句、switch语句；

c) 循环语句，如while语句、for语句。

这些语句的参数说明、条件说明和循环控制都放在圆括号内。如果特别长，应尽量将具有紧密逻辑联系的语句放在同一行内。

同时注意，参数说明、条件说明和循环控制的结束圆括号“)”与体开始花括号“{”之间留一个空格或者换行符。

3.5 注释

注释是软件可读性的具体体现。程序注释量一般占程序编码量的20%，软件工程要求不少于20%。以下是四种必要的注释：

（1） 类说明注释

注释一般位于 import 语句之后，class 描述之前。要求至少写出内容说明、最近修改时间、注意事项等内容。例如：



（2） 方法说明注释

对几乎每个方法都应有适当的说明，位于方法声明之前，包括：方法描述，参数说明、异常说明、返回值说明和特别说明等。例如：



（3） 体内代码的注释

体(方法体、代码块体、静态代码块体等)内的代码按照功能分成多个虚拟的功能块，每个块以块注释“/* xxx */”注释开始；例如：



（4） 变量注释

以“//”开头，描述该变量的用途以及使用的注意事项，如：

//爬取成功网页数