java注释

java注释

1. 单行注释

   // 单行注释
   

2. 多行注释

   /*
   	多行注释
   	多行注释
   	多行注释
   */
   

3. 文档注释

   格式：
   /**
   	@author 	指定java程序的作者
   	@version 	指定源文件的版本
   */
   

   注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式体现的该程序的说明文档。

   /**
   	文档注释
   	@author nkcll
   	@version v1.0
   	这是我的第一个java程序
    */
    public class HelloJava{
   	 /**
   	 如下的方式是main()，作用：程序的入口
   	  */
   	 public static void main(String[] args){
   		 System.out.println("Hello,World!");
   	 }
    }
   

   然后输入命令

   javadoc -d myHello -author -version HelloJava.java
   

   如果显示有 编码GBK的不可映射字符 的错误问题，就在后面加上

   -encoding utf-8 -charset utf-8
   

   即

   javadoc -d myHello -author -version HelloJava.java -encoding utf-8 -charset utf-8
   

   -d表示生成的网页文件夹的名称

   -author表示网页文件中会标出author

   -version表示网页文件中会标出version

   -encoding utf-8 表示解码用utf-8

   -charset utf-8 表示字符集用utf-8