Java程序开发规范精要.docVIP

Java 编程规范 注：本规范适用于北京工业大学教育部数字社区工程研究中心进行java开发，还待进一步完善。 日期 操作 版本 作者 2009-4-3 起草文件 V1.0 赵忠诚  Java程序开发规范 绪论 目的: 本规范目的是为了使本组织能以标准、规范、统一的编程风格进行Java代码的开发工作。提高程序的可读性、可修改性和可维护性，方便团队的交流。 本规范参考了: Code Conventions for the JavaTM Programming Language 高质量C++编程 范围: 本规范适用于教育部数字社区工程研究中心使用Java开发团队所有成员，进行产品开发、维护以及升级等编程操作。 概要说明: 在这里引用文献1来说明代码规范的重要性: 一个软件的生命周期中，有80%都在进行维护很难有软件在整个生命周期中，都是由原来的作者进行维护的编码规范提高了软件的可读性，并且帮助软件工程师更加快速彻底地理解新的代码要想把你的源代码作为产品来发布，就需要保证它像你创作的其他作品那样被很好地封装，并且清理干净了。Java开发规范。 重要说明: 本规范为内部共享资源，版权属于教育部数字工程研究中心，如果现在或者以后有好的建议可以直接在该文件中进行添加和修改。 代码整体组织和风格 这里所说的代码的整体组织和风格是针对一个文件而言，一个文件应该是由被空行分隔开的代码块所组成，并且每个块被特定的注释标识出来。Java源文件 Java源文件必须包含一下几个部分(按照从上到下的顺序说明)：版权说明、包和引用语句、类/接口描述以及版本信息、类方法以及变量声明和实现。 版权信息，所有的源文件都应该由列出了类名，日期和版权信息的C-style的注释开始/** * @{#}S.java Created on 2009-4-6 * * CopyRight (c) 2009 BJUT,BeiJing. * All right reserved. */ 包和引用语句, 大多数Java源文件的第一个非注释代码行都是包定义语句package edu.bjut.bjwater.checkrules.action; import java.text.NumberFormat; import java.text.SimpleDateFormat; import java.util.*; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpSession; import edu.bjut.bjwater.pub.*; 类/接口描述以及版本信息 /** * @Package: src.test * @Description: TODO(用一句话描述该文件做什么) * @author : yan * @date : 2009-4-6 * @version: V1.0 * * @version @date @author @modify * --------- ----------- ---------- ------------------ * 修改之后版本 修改日期 修改者 修改内容 */首先是public的类变量，然后是protected的,接下来是包级的（没有访问修饰符），最后是private的。/** something ......*/ public static String str = “test”; ………………… /** * Set the character set for the file. */ private static Charset charset = Charset.forName(ISO-8859-15); /** something ......*/ public String str = “test”; /** * The character buffer reference. */ private CharBuffer indexFile; 变量声明同时也要添加相应注释，注释这个变量的功能，如果是一个较复杂的数据结构形式，将其存贮的格式也表示出来，方便理解程序同时也方便其他人的程序调用。 构造函数和方法:构造函数也是方法但是它没有返回值，本规范规定，想写构造函数在写其他的方法。方法也要加上注释，说明这个方法实现的功能等信息，例如 /** * @Title : main * @Descr