Java Coding Draft.docVIP

Java Coding Draft 中天科技[] 作者: 王德良[wangdl@] 修订:2003-2-14 目录 序 3 1．简介 4 1．1介绍 4 1．2内容 5 2．结构和文档 6 2．1包 6 2．2源文件 6 2．3类和接口 7 2．4类变量 8 2．5方法 9 2．6内部程序注释 9 2．7布局 10 2．8空格 12 2．9折行 13 3．命名规范 13 3．1 包 13 3．2 文件 13 3．3 类 14 ? 区分同名的接口的类命名规则 14 ? 例外类 14 3．4 常数 14 3．5 变量 14 ? 类私有和保护变量 14 ? 局部变量 15 3．9 方法 15 4．建议 16 4．1 类 16 4．2例外处理 16 4．3变量 18 4．4方法 18 4．5技术要点 19 4．6公共部分 20 5．举例 20 5.1 Example.java 20 5.2 package.html 23 序 在阅读该篇文章之前,请仔细阅读下面的文字： 任何项目和组织都不会处于一种真空无组织的状态，因此如果可 能，请使用本文的约定，不必重新制定。 任何标准都不会是最完美的，也不会适用于全部情况，所以如果 将来标准的某条内容不适用了，我们应该改变标准适应新的情 况，并将新的标准归档，记录改变的原因。 在开始使用标准之前我们必须认真学习标准，理解每条标准，包 括具体含义，什么时候使用，怎样使用等。 1．简介 1．1介绍 编程规范对编程人员来说是非常重要的，其原因如下： 维护费用占软件成本的80％左右 大部分软件不是由初始开发人员来维护的 编程规范提高了软件代码的可读性，使软件工程师可以很快地完全理解程序代码 便于将代码发布成产品 1．2内容 结构和文档 介绍编写产品和文档的标准。 命名规范 描述命名标识符的标准（标识符包括类名称、方法名称、变量名称等）。 建议 有关JAVA编程的经验和建议 案例 “Example.java”示例本文描述的编码规范。 “Package.html”示例本文描述的文档编写规范,用来概述一个包功能。 附录 参考书目列表 2．结构和文档 2．1包 为每个工程和功能模块定义一个新的JAVA包名，JAVA文件目录与包名一致。 在每个目录里都要编写一个package.html，简短的描述该包的功能和结构。 2．2源文件 每个类对应一个独立的文件。该规范还适用于那些可以独立出来的非公共类。 每个JAVA源文件必须以注释开始，注释格式如下： 1．The copyright 2. The “$Id$” tag 3. 一个历史列表（日期、作者、变化描述） 4．如果包含多个类，则列出每个类及其功能简要描述 然后仅跟着一个文件头： 空行 包名 空行 import列表 例子： /** * Copyright (C) 2000, Zhongtian Inc. * * The program(s) herein may be used and/or copied only with * the written permission of Intalio Inc. or in accordance with * the terms and conditions stipulated in the agreement/contract * under which the program(s) have been supplied. * * $Id: Example.java ,v 1.1 2000/08/03 22:11:13 authorname Exp $ * Date Author Changes * Aug 2 2000 author-name Created * Aug 2 2000 author-name Added new classes */ package demo; import java.util.NoSuchElementException; 2．3类和接口 在写注释（／＊＊ ＊／）时，一定要遵守Javadoc的约定。 使用注释（／＊＊ ＊／）简要描述类的功能、使用方法、具体的使用例子，还有对类某些功能使用上的提示（禁用、增加等）。使用HTML格式，并且增加下面的控制标签： @author a href=”mailto:e-mail address”author-name/a @version $Revision$ $D