javaSE-注释

• 单行注释

//注释内容

• 多行注释

/*
注释内容
注释内容
注释内容
注释内容
注释内容
注释内容
注释内容
*/

        注：多行注释不能嵌套使用。例如① /*   外注释②/*内注释③*/    ④*/ 

        ①处/* 会与③处匹配 导致多出来一个④处的*/

• 文档注释

        格式

/**
@author    指明作者
@version   指定源文件版本
*/

        文档注释可以被 javadoc工具解析生成一套以网页文件形式的说明文档

Javadoc命令

Javadoc 用法格式如下：

javadoc [options] [packagenames] [sourcefiles]

对格式的说明：

• options 表示 Javadoc 命令的选项；
• packagenames 表示包名；
• sourcefiles 表示源文件名。

在 cmd（命令提示符）中输入javadoc -help就可以看到 Javadoc 的用法和选项（前提是安装配置了JDK），下面列举 Javadoc 命令的常用选项：

名称 说明 -public 仅显示 public 类和成员 -protected 显示 protected/public 类和成员（默认值） -package 显示 package/protected/public 类和成员 -private 显示所有类和成员 -d <directory> 输出文件的目标目录 -version 包含 @version 段 -author 包含 @author 段 -splitindex 将索引分为每个字母对应一个文件 -windowtitle <text> 文档的浏览器窗口标题

javadoc使用

        1.先写一个带有文档注释的java测试文件

/**
@author xiaofulu
@version v12.0.1
一个测试程序
*/

public class Hello
{
	public static void main(String agr[])
	{
		System.out.println("Hello");
	}
}

        2. 打开命令行使用javadoc指令，输入：javadoc -d myjava -author -version Hello.java

其中myjava表示生成的文件夹名称 -author表示作者 -version表示版本 Helle.java是要解析的文件

回车后会生成一个文件夹。

 打开首页index.html，会出现注释信息

 

注：若用记事本写源程序是，出现错误“编码 GBK 的不可映射字符 (0x8F)”

需要将文件另存为 将编码改为“ANSI”

原因：我们java的IDE的一般默认编码是UTF8的，修改为以ANSI格式编码，