java编码规范及注释快捷键.docVIP

3 文件组织(File Organization) 一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。Java源文件范例提供了一个布局合理的Java程序范例。 3.1 Java源文件(Java Source Files) 每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。 Java源文件还遵循以下规则： - 开头注释（参见开头注释）- 包和引入语句（参见包和引入语句）- 类和接口声明（参见类和接口声明） 3.1.1 开头注释(Beginning Comments) 所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、版本信息、日期和版权声明： /* * Classname * * Version information * * Date * * Copyright notice */ 3.1.2 包和引入语句(Package and Import Statements) 在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如： package java.awt; import java.awt.peer.CanvasPeer; Add import: Ctrl+Shift+M 3.1.3 类和接口声明(Class and Interface Declarations) 类/接口声明的各部分 注解 1 类/接口文档注释(/**……*/) 该注释中所需包含的信息，参见文档注释 2 类或接口的声明 3 类/接口实现的注释(/*……*/)如果有必要的话 该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。 4 类的(静态)变量 首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。 5 实例变量 首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。 6 构造器 7 方法 这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。 方法的注释：声明好方法后，在向方法里写实现的代码前，在方法前 /** + 回车键，就行了，如果方法实现了，这个则不起效果 下面的例子，展示了如何合理布局一个包含单一公共类的Java源程序。接口的布局与其相似。 /* * @(#)Blah.java 1.82 99/03/18 * * Copyright (c) 1994-1999 Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. * All rights reserved. * * This software is the confidential and proprietary information of Sun * Microsystems, Inc. (Confidential Information). You shall not * disclose such Confidential Information and shall use it only in * accordance with the terms of the license agreement you entered into * with Sun. */ package java.blah; import java.blah.blahdy.BlahBlah; /** * Class description goes here. * * @version 1.82 18 Mar 1999 * @author Firstname Lastname */ public class Blah extends SomeClass { /* A class implementation comment can go here. */ /** classVar1 documentation comment */ public static int classVar1; /** * classVar2 documentation comment that happens to be * more than one line long */ private static Object classVar2; /** instanceVar1 docum