JAVA编码范.docVIP

开发命名规范 JAVA编码规范 目 录 TOC \o 1-3 \h \z \u HYPERLINK \l _Toc226521342 1 概述 PAGEREF _Toc226521342 \h 3 HYPERLINK \l _Toc226521343 1.1 编写目的 PAGEREF _Toc226521343 \h 3 HYPERLINK \l _Toc226521344 1.2 预期读者 PAGEREF _Toc226521344 \h 3 HYPERLINK \l _Toc226521345 1.3 适用范围 PAGEREF _Toc226521345 \h 3 HYPERLINK \l _Toc226521346 2 命名规范 PAGEREF _Toc226521346 \h 4 HYPERLINK \l _Toc226521347 2.1 包命名规则 PAGEREF _Toc226521347 \h 4 HYPERLINK \l _Toc226521348 2.1.1 与业务系统相关的包命名 PAGEREF _Toc226521348 \h 4 HYPERLINK \l _Toc226521349 2.1.2 与业务系统无关的、可公用的包 PAGEREF _Toc226521349 \h 4 HYPERLINK \l _Toc226521350 2.2 类名、接口命名规则 PAGEREF _Toc226521350 \h 5 HYPERLINK \l _Toc226521351 2.3 方法命名规则 PAGEREF _Toc226521351 \h 5 HYPERLINK \l _Toc226521352 2.4 变量命名规则 PAGEREF _Toc226521352 \h 5 HYPERLINK \l _Toc226521353 2.5 常量命名规则 PAGEREF _Toc226521353 \h 6 HYPERLINK \l _Toc226521354 3 代码书写规范 PAGEREF _Toc226521354 \h 7 HYPERLINK \l _Toc226521355 3.1 返回值 PAGEREF _Toc226521355 \h 7 HYPERLINK \l _Toc226521356 3.2 异常 PAGEREF _Toc226521356 \h 7 HYPERLINK \l _Toc226521357 3.3 表达式 PAGEREF _Toc226521357 \h 8 HYPERLINK \l _Toc226521358 3.4 体前代码 PAGEREF _Toc226521358 \h 8 HYPERLINK \l _Toc226521359 3.5 注释 PAGEREF _Toc226521359 \h 9 HYPERLINK \l _Toc226521360 4 代码规范举例 PAGEREF _Toc226521360 \h 11 版本变更说明 版本 完稿时间 撰写人 说明 1.0 2009-3-27 刘华 初稿 概述 编写目的 本文描述了JAVA开发中的有关包、类、接口、方法、实例变量、变量和常量的命名规则，用于规范JAVA编程过程中的命名和代码书写规范。 预期读者 开发组全体成员。 适用范围 适用于开发组所有基于JAVA开发的项目。 命名规范 包命名规则 开发组将基于JAVA开发中产生的包分为两类，一是与各业务系统相关的包，一是与业务系统无关的、可公用的包。它们的命名规则除要遵守“包名应全部是小写字母，包名中不能出现下划线，并且第一个字母不能是数字”的规则。 与业务系统相关的包命名 与业务系统相关的包命名格式为： com.wisoft.projectname.modulename。 其中： projectname为项目英文简称或缩写；modulename为模块英文名称或简称，如果无细分模块的话可省略模块名。 与业务系统无关的、可公用的包 通用包命名格式为： com. mon.modulename//所有项目通用 com.wisoft.projectname.common//单个项目内各模块通用 类名、接口命名规则 类和接口的名称应是一个名词，采用大小写混和的方式，如果使用拼音则应是全拼，所有单词都应紧靠在一起，其中每个单词的首字母应大写，接口名称应以大写I开始。例如： class User； interface ICommonConnection； class BuMen;//此处为部门全拼 每个类定义要前必须加类的说明。 方法命名规则 方法名应是一个动词或动名结构，采用大小写混和的方式，其中第