《JAVA编程规范.docVIP

文档编号：HSSC-JS-AA-BCGF-01 文档密级：公开 传阅方式：Word文档 JAVA编程标准和规范 （草案） 武汉海视三创科技有限公司 2014.11 作为一个程序员，在使用一门开发语言开发软件时，除了要掌握这门语言的基本语法、各种函数、语句的功能并完成软件的功能需求外，还有很重要的一点是要养成一个良好的编码习惯，也就是要编写一个规范的、易读的程序，这对于整个软件的后期维护尤其重要。程序员可能都有这样的体会：宁愿自己重新编写，也不愿意去阅读并修改别人编写的没有说明或文档的程序，这对于系统的维护是非常不利的。 在软件开发过程中，同一项目中参与编程的人可能有各自编程的经验和习惯，不同风格的程序代码带来了维护工作量的增加。为了提高代码的可读性、系统的稳定性，降低系统维护和升级的成本，程序的代码必须严格遵循统一的编程规范。经验证明，把时间花在项目的开始，写出高质量的代码，可以使后来开发过程中的修改工作变得十分容易，从而达到事半功倍的效果。同时，遵循一系列编码规范，可以使一个开发团队更好的保持一致性，最终必将极大的提高团队的生产力。因此，一个项目开发组在编码之前，首先要制定该项目的编程详细准则，即规范。 前言 为确保系统源程序可读性，从而增强系统可维护性，兹制定下述编程规范，以规范系统各部分编程。系统继承的其它资源中的源程序也应按此规范作相应修改。 使用范围 本文档将作为海视三创应用系统软件（JAVA语言）开发的编程格式规范。在系统的编码、测试及维护过程中，要求严格遵守。 界面规范 一般性约定 界面设计是软件设计中很重要的一部分，一些优秀的软件大都拥有优秀的界面设计，很多大公司有专门的界面设计实验室，有程序员、美工等共同参与，界面设计往往精确到像素。 在系统开发时，争取提供给用户一个优秀的界面，但对于优秀界面的理解不能是“漂亮”甚至是“花哨”，而忽略了更为重要的东西。 一个优秀的界面设计应该具有如下特征： 功能性 界面设计必须符合功能的需要，这个是最重要的。界面是用户使系统的交互途径，优秀的界面必须与功能的需求相统一。 导航性 优秀的界面应该给用户舒适的导航，用户可以很容易找到相应的功能，或者可以引导用户正确的操作，避免错误。应该重点突出、结构清晰、布局具有整体感。 友好性 不要出现用户看不明白的提示、专业术语或错误消息。例如：在JAVA中编写表单窗口录入程序时，若用户录入违反了约束（如关键字重复、非空项没有输入等），程序报的英文出错信息应该屏蔽，以中文提示信息取代。 操作性 一个优秀的界面设计，必须具有良好的操作性，符合大多数人的操作习惯，对于特殊应用，可快速操作也很重要。 美观和协调性 界面设计要注意美观和协调性，如颜色不能过于鲜艳或反差太大给人刺眼的感觉，控件布局要合理。 时尚性 密切注意流行界面的方向，适合系统特点的可以加以利用，当然也不要盲目跟从。 具体约定 具体约定设计到系统界面约定的一些非常细的内容，并且根据项目性质、特点和用途的不同而不同，各系统应该根据项目特性来制定界面标准，统一规范。主要内容应该包括以下几个方面： 应用程序总体界面规范 明确总体界面风格，如分辨率、MDI多文档界面、主菜单、工具栏、打开子工作表窗口的方式等。 窗口界面规范 确定窗口界面的风格，如窗口的颜色、字体、控件布局、边框形式等。 表单窗口对象界面规范 确定表单窗口对象界面风格，如表单窗口对象的标题字体、命名、背景颜色以及各种类型字段的编辑风格等。 提示规范 明确系统对用户的提示信息，如当录入数据或保存数据出现错误的提示信息或警告：数据输入正确，继续执行的提示；对记录进行修改后跳到其他记录或关闭当前窗口等时询问是否存盘等提示。 其他要求 界面自适应、界面统一规范（按钮）、消息规范、字体规范 校验 增加、删除、修改、保存，必须要对数据进行有效性、唯一性、完整性、冗余性等校验； 业务流程保证完整流通。 代码规范 命名规范 使用英文单词描述各种变量、对象 尽量使用全名，谨慎使用缩写 避免太长的名称 下划线分隔 保持命名的一致性（变量、函数、触发器、存贮过程等） 层次规范 层次分明 注释规范 注释是程序编写不可缺少的，必要的注释能使程序更容易被自己、合作者以及后来参与这个项目的任何其他程序员更好的理解，为软件维护提供方便。 注释编写的要求：软件维护的时候，即使不看源程序，只看注释的内容，也能够充分理解程序内容。 注释主要记述以下几方面的问题：功能、设计说明、限制事项、边界条件、假定或潜在的问题等。 注释不是程序语句的改头换面，一目了然的脚本不用加注释，而应从更高的一个层次来阐述说明。 注释要求能占程序总量的20 – 30 %，脚本和注释必须同步编写，而不应该等整个编码结束后再来添加注释，另外注释必须