JAVA——注释

JAVA——注释

一.Java的注释方式

Java中有三种注释方法，且在运行时均不会显示

• // …… 单行注释
• /* … */ 多行注释
• /** … */多行注释

二.两种多行注释的异同

• 两种多行注释在运行时均不会显示
• 但以/**……*/注释的内容会写入javadoc生成的help文档中
• 而 /* … */ 注释的内容不会出现在javadoc生成的help文档中

三.注释使用示例

/** 
   * @author  lingyu 
   * @version  1.0
   *（我是文档注释,我可以在help文件中显示）
   */  
public class TestComment { 
    /**  
      * 方法注释（我也是文档注释,我也可以在help文件中显示） 
      * @param args 
      */ 
      public static void main(String[] args/*我是行内注释，用多行注释符，我不可以在help文件中显示*/) {  
      	  System.out.println("测试注释");//我是单行注释，我也不可以在help文件中显示 
      	   }
}

四.javadoc的作用和用法

javadoc：用于将Java源代码中的某些文档注释生成帮助文档，如：javadoc -d c:\help -author -version HelloWorld.java

• -d：其后空一格，用来指定生成的帮助文档存放的位置
• -author：用来指定生成的帮助文档必须显示该类的作者，如果没有这一命令则生成的帮助文档将不会显示作者
• -version：用来指定生成的帮助文档必须显示该类的版本，如果没有这一命令则生成的帮助文档将不会显示版本