[2.命名规范.docxVIP

开发命名规范版本信息* A代表新增，M代表修改，D代表删除。版本号发布日期提交人审阅人A.M.D更新位置更新摘要V1.02014-07-26李健进A拟初稿V1.12014-08-28李健进M精简部分重复无意义描述V1.22014-11-05李健进M3.3.33.3.43.3.51:将变量分为类成员变量与形参变量2:逻辑代码注释使用单行注释风格注释目录1概述51.1目标51.2应用范围52Java命名规范52.1通用命名原则52.2详细命名原则62.2.1包的命名标准62.2.2类或接口的命名原则62.2.3变量/属性/对象的命名原则62.2.4函数的命名原则72.2.5getter函数的命名原则72.2.6setter函数的命名原则72.2.7常量的命名原则73Java注释规范83.1注释编写原则83.2注释类型83.2.1Java 注释语句类型83.2.2javadoc标志93.3注释约定113.3.1类的注释113.3.2函数的注释113.3.3类成员变量的注释113.3.4形参变量的注释123.3.5逻辑代码的注释124Java工程命名规范124.1Jar工程编程原则124.1.1Jar工程的职责范围124.1.2Jar工程的命名原则124.2WEB工程编程原则134.2.1WEB工程的职责范围134.2.2WEB工程的命名原则134.2.3WEB工程文件的组织结构原则135数据库命名规范135.1数据库表命名原则135.2数据库表字段命名原则14概述目标建立一个可操作的编程标准、约定和指南，以规范公司的产品研发工作，提高代码的可读性和可维护性；提高系统的健壮性、稳定性和可靠性，确保产品质量。同时，为了确保研发工作，不会因为队部的调整或员工的离职而给后续的研发工作和软件维护带来不利影响，并在产品研发过程中，必须遵循一种规范的程序设计标准，通过这些程序设计标准，提高Java软件开发者的生产效率，培养高素质的团队。应用范围本编程标准的应用范围为所有从事Java软件开发、软件产品维护和技术支持人员。Java命名规范通用命名原则所有标识符均使用完整的英文单词或缩写词方式命名，并附有中文注释。其命名原则有：使用能准确说明对象意义的大小写英文单词描述，禁止使用拼音命名。如合计，错误：heji，正确：total；采用该领域的术语。如会议的“议题”，应使用MeetingTopic而不采用MeetingName命名； 避免使用长名字（最好不超过 15 个字母）。虽然PhysicalOrVirtualProductOrService似乎是个不错的类名，但这名字太长了，应该考虑重新给它起个短一点的名字，如 Offering；避免在同一个类中使用相似或者仅在大小写上有区别的名字。例如 anSqlDatabase和anSQLDatabase；避免使用下划线作为名字的首末字符。以下划线为首末字符的名字通常为系统保留。详细命名原则包的命名标准关于包的命名应遵循以下规则：包的命名全部使用小写的英文单词或缩写词组成，每个包名称之间用点号‘.’分隔开来。如com.excellence.exoa.missive； 包的命名约定：com.excellence.产品名.模块名.功能 。如：公文处理dao包的应命名为：com.excellence.exoa.missive.dao； 常规包命名如下（以任务模块为例）：工具包（util） ：com.excellence.exoa.task.util；数据库（dao） : com.excellence.exoa.task.dao；标签（tag） : com.excellence.exoa.task.tag；异常（exception）: com.excellence.exoa.task.exception；Action（action） : com.excellence.exoa.task.action；VO（vo） : com.excellence.exoa.task.vo;类或接口的命名原则每个Java源程序文件包含单一的类，命名原则为每个英文单词的首字母为大写，其它的为小写，如：Customer.java、Singleton.java、DeptInfo.java。说明：对一些不同操作类型的类可以按操作类型进行命名，如：Action类可命名为：模块名称+Action.java；Dao类可命名为：模块名称+Dao.java。变量/属性/对象的命名原则变量、字段、属性或对象的命名原则为第一个英文单词为小写，其它的首字母为大写，其它的为小写。只允许使用英文+数字的组合。如：firstName、zipCode、unitPrice、discountRate、orderItems函数的命名原则函数的命名应采用完整的英文描述符。原则