广州精点JAVA编写规范v1.0

《广州精点JAVA编写规范v1.0》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、密级：内部公开文档编号：KingPoint_RD_REGU_JAVABCGF版本号：V1.0JAVA语言编码规范广州精点计算机科技有限公司编制：粟珍生效H期：2010-10-09审核：EPG批准：涂锋广州精点计算机科技有限公司对本文件资料享受著作权及其它专属权利，未经书面许可，不得将该等文件资料（其全部或任何部分）披露予任何第三方,或进行修改后使用。版本历史日期版本作者修改内容2011-2-23V01.00粟珍编与代码文档1前言目录2JAVA代码规范6错误!未定义书签。2.1文件名62.1.1文件后缀62.1.2常用文

2、件名72.2文件组织7221Java源文件72.2.2开头注释72.2.3包和引入语句82.2.4类和接口声明82.3缩进排版82.3.1行长度82.3.2换行82.4注释102.4.1实现注释的格式112.4.2文档注释122.5声明132.5.1每行声明变量的数量132.5.2初始化132.5.3布局142.5.4类和接口的声明142.6语句152.6.1简单语句152.6.2复合语句152.6.3返冋语句15if,if-else,ifelse-ifelse语句15for语句16while语句16do-while语

3、句1717switch语句2.72.6.9try-catch语句空白17182.7.1空行182.7.2空格182.7.3换行192.8命名规范20202.8.1包282类212.&3接口212.8.4方法212.8.5变量222.8.6常量222.9编程惯例232.9.1提供对实例以及类变量的访问控制232.9.2引用类变量和类方法232.9.3常量232.9.4变量赋值232.9.5其它惯例242.10代码范例252.10」Java源文件范例253前台设计263.1JSP设计规范263.1.1页眉、页脚和样式表26

4、3.1.2页面标题273.1.3窗口大小和位置273.1.4超链接273.1.5按钮273.1.6处理结果273.1.7操作确认273.1.8数据验证283.1.9控件使用283.1.10视图状态283.1.11数据库访问283.1.12HTML页面中需要注意的地方293.2javascript编写规范303.2.1引用规范303.2.2变量命名规范303.2.3变量的赋值313.2.4JavaScript常数313.2.5注释313.2.6if语句313.2.7循环体32switch语句32Js验证333.3Css3

5、34数据库规范334.1表334.1.1命名规范334.2视图344.2.1命名规范344.2.2注释344.3存储过程344.3.1命名规范344.3.2注释354.3.3返回操作结果代码354.3.4使用事务364.4自定义函数364.4.1命名规范36注释36SQL语句规范374.5.1关键字规范374.5.2缩进间距374.5.2代码格式化374.5.3插入操作时,应该给出列名394.5.4SELECT列要使用表的别名394.5.5其它应注意事项404.6版本控制40本文在参考业界己有的编码风格的基础上，描述了

6、一个基于Java的项目风格，力求一种统一的编程风格，并从整体编码风格、代码文件风格、函数编写风格、变暈风格、注释风格等儿个方面进行阐述。编码规范对于程序员而言尤为重要，有以下几个原因：个软件的生命周期中，80%的花费在于维护-儿乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员來维护-编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码-如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的为了执行规范，每个软件开发人员必须一致遵守编码规范。2JAVA代码规范2.1文件

7、名这部分列出了常用的文件名及其后缀。2.1.1文件后缀Java程序使用下列文件后缀:文件类别文件后缀Java源文件.javaJava字节码文件•class2.1.2常用文件名常用的文件名包括：文件名用途GNUmakcfilcmakcfiles的首选文件名。我们采用gnumake来创建（build）软件。README概述特定目录下所含内容的文件的首选文件名2.2文件组织一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。"Java源文件范例〃提供了一个布局合理的J

8、ava程序范例。2.2.1Java源文件每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。Java源文件还遵循以下规则：-开头注释（参见〃开头注释〃）-包和引入语句（参见〃包和引入语句〃）-类和接口声明（参见〃类和接口声明〃