JAVA项目之源代码书写规范.pdf

Copyright © 2013 cao hai yang. 曹海洋技术笔记 JAVA 项目之源代码书写规范 1.简介 JAVA 项目源代码要遵循的一定准则,以提供统一的代码风格，方便代码的可读性与可维护性。 一个编程团队都要维持的同步性及连贯性规定。 任何一个程序员都可以查看他人的编码，而且可以充分的理解以便用其进行工作。 新加入团队的人员可以迅速充分的融入编码环境中。 产生于编码作业中的错误需要消除。 不断提高编码的可维护性。 不断提高编码效率。 2.命名规范 命名规范使得程序更加易懂，它可以提供有关方法标识符的信息，不论是常量、包或类，都可有助 于理解代码。 2.1 单词分割 a.代码文件：统一使用匈牙利命名法命名。文件名除 class类外首字母小写。 b. JSP 以及HTML 文件：由于 JSP 文件一般不会使用文件夹进行划分并且这类文件相对较多，如果采 用匈牙利命名法，名称可读性不强，查找不方面。因此统一采用不会影响搜索引擎的“-”进行划词分割。 2.2 语法结构 语法结构主体采用动宾结构，动作说明其操作类别，名称表明操作实体。所用动词是本文档限定的， 部分名词也做了限定。所用单词尽量限制在 4-5 个，如果单词过长，可以用语义清楚的缩写进行表示。 关键词限 类别 英文单词 简介 定 动词 添加 save 添加操作 动词 编辑 update 含查看功能，但是可以编辑的功能模块，统称编辑。 动词 删除 delete 删除操作 动词 查看 View,find 用于获取和查看单条记录 动词 浏览 list 查看记录集合时使用 用于查看多条记录的功能描述（如： email ：caohy@189.cn /p/caohy189cn?from=wenku 第 1 页 Copyright © 2013 cao hai yang. 曹海洋技术笔记 viewList、searchList、top**List） 动词 导入 import 导入操作 动词 导出 export 导出操作 动词 公共的 common 公共 特殊 成功 success 状态 特殊 失败 failure 状态 特殊 错误 error 状态 后缀 接口实现 Impl 后缀 Action 类 Action 包含非获取列表方法的 Action 类 包含所有的列表方法 (如果只有一个列表方法，可以不单独定义 后缀 Action 类 ListAction 这个类) 后缀 Service 类 Manager 后缀 DAO Dao DAO层类 后缀 工具 util 工具类 2.3 文件命名 Java 源文件名要与其中包含的公共类名相同（包括character case），要以.java 为扩展名。编译 java 文件要以.class 为扩展名 2.3.1 包的名称 对于包名称，用所有字母的小写形式。包名称必须以 部域名的