软件开发代码规范(Java)[19页].docVIP

PAGE / NUMPAGES 封 面 作者：ZHANGJIAN 仅供个人学习，勿做商业用途 软件开发代码规范 （C） (仅通普信息技术股份有限公司供内部使用) 拟制： 杨超 日期： 2015-3-10 审核： 夏峰 日期： 2015-3-10 核准： 冯敬刚 日期： 2015-3-17 签发： 韩殿成 日期： 2015-3-21 文档版本：V1.11 黑龙江通普信息技术股份有限公司 版本历史 日期 版本 说明 作者 目录 TOC \o 1-3 \h \z 第一章 代码开发规范及其指南 1文档收集自网络，仅用于个人学习 1.1 目的 1文档收集自网络，仅用于个人学习 1.2 程序内命名规范 1文档收集自网络，仅用于个人学习 1.3 文件命名规范 2文档收集自网络，仅用于个人学习 1.4 Java 文件样式 2文档收集自网络，仅用于个人学习 1.5 代码编写格式 6文档收集自网络，仅用于个人学习 第二章 程序编写规范方法 8文档收集自网络，仅用于个人学习 2.1 权限修饰 8文档收集自网络，仅用于个人学习 2.2 其他规范 8文档收集自网络，仅用于个人学习 2.3 编程指南 10文档收集自网络，仅用于个人学习 第三章 其他要求 12文档收集自网络，仅用于个人学习 个人收集整理 勿做商业用途 PAGE2 / NUMPAGES2 代码开发规范及其指南 目的 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 文档收集自网络，仅用于个人学习 程序内命名规范 Package 的命名 ：Package 的名字应该都是由一个小写单词组成。 Class 的命名 ：Class 的名字必须由大写字母开头而其他字母都小写的单词组成 Class 变量的命名 ：变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。 Static Final 变量的命名 ：Static Final 变量的名字应该都大写，并且指出完整含义。 文档收集自网络，仅用于个人学习 参数的命名 ：参数的名字必须和变量的命名规范一致。 数组的命名 ：数组应该总是用下面的方式来命名： byte[] buffer; 而不是 byte buffer[];文档收集自网络，仅用于个人学习 方法的参数 ：使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： SetCounter(int size){ this.size = size; } 文件命名规范 文件名由英文单词组成，每个单词的首字母大写，不要超过4个单词，如ShipOrder.jsp。 Java文件的文件名要与程序中的public类名相同。 Servet文件要以Servlet做为结尾，如AddCompanyServlet.java 业务处理组件JavaBean要以Bean为结尾，如ProcessBean.java Java 文件样式 所有的 Java(*.java) 文件都必须遵守如下的样式规则 头部 版权信息 版权信息必须在 java 文件的开头，比如： /** * Copyright 2002 Sun Microsystems, Inc. All rights reserved. */ 其他不需要出现在 javadoc 的信息也可以包含在这里。 Package/Imports package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。 文档收集自网络，仅用于个人学习 package .stats; import java.io.*; import java.util.Observable; import hotlava.util.Application; 这里 java.io.* 使用来代替InputStream and OutputStream 的。 Class 接下来的是类的注释，一般是用来解释类的相关信息，包括标题、描述、。 /** * pTitle: Example/p * pDescription: AuditApplicationExample/p * pCopyright: Copyright (c) 200x/p * pCompany: xxxxx/p * @author xxxx