Sponsored Link

Java基础之 Java注释

2008-01-26 15:35Update

TAGS: Java注释

LifevV.COM编辑部

Page Options

Recommend To Friend

本文介绍Java注释的概要，几种注释的方法，注释范例等。

Java注释概要
为了方便以后的维护，我们希望在源代码中加入注释。其实，在源代码中写上好的注释，是一个良好的开发习惯。一方面，注视可以帮助自己或者他人能更好地理解源代码/代码段的用途，使用条件，使用方法，结果等；另一方面，便于以后的系统维护和升级等。

在Java里，一种Javadoc格式的注释还能为我们自动生成帮助文档。

Java注释

Java里，可以使用三种注释的方法：
1，行注释：
行注释也称单行注释。
行注释使用 // 注释文字 来对某行/某段代码加以说明。
2，段落注释：
段落注释也称多行注释。
它使用 
/*
   注释文字
 */
为某段代码加以说明。通常当 说明文字 比较长需要换行时使用段落注释方法。
3，文档化注释：
文档化注释也称Javadoc注释。
采用这种方法的注释，可以采用javadoc命令或工具抽取源文件里的Javadoc注释，生成组织有序的帮助文档（HTML格式的文件）。

Java注释例

											
											
											
											
											/**
 * Javadoc注释方法：
 * 这是一个Java Hello world！的程序
 * <p>
 * 可以打印Java Hello World!
 *
 * @author  lifevv.com
 * @version 1.0.1, 2008-01-25
 */
public class HelloWorld{
    /*
     * 段落注释方法：
     * main()方法
     */
    public static void main(String [] args) {
        //行注释方法  
        //打印语句 
        System.out.println("Hello world!");  //行注释：打印语句
    }
}

										


有关Javadoc的详细说明，我们在其他文章中讨论。
									