11_初识Java_注释及javadoc_认识使用

11_初识Java_注释_认识

注释作用

  • 注释不会参与编译,编译后产生的字节码文件中不会有注释的内容,方便调试
  • 注释起到标注解释的作用,提高代码的可读性,方便自己与其他阅读者
  • 文档注释可以配合JDK提供的javadoc.exe可以生成一套网页版说明文档

添加注释方式

  • 单行注释 //
// 2个斜杆开始 单行注释
  • 多行注释 /* */
/*
	这里是多行注释
	可以多行写
	可以多行写
*/
  • 文档注释 /** */
/**
  文档注释
 @author llg
 @version 1.0
*/

例子


/**
  文档注释
 @author llg
 @version 1.0
*/

// 2个斜杆开始 单行注释

/*
	这里是多行注释
	可以多行写
	可以多行写
*/

// 这是一个类,名叫HelloWorld,一般驼峰法命名,见名知意
public class HelloWorld{
	//下面是一个main方法,方法格式是固定的
	public static void main(String[] args){
		System.out.println("hi 这还是我的一段java程序");
		//System.out.println("hi 这还是我的一段java程序2");
		System.out.println("hi 这还是我的一段java程序3");
	}
	/**
     @param name 名字
	 @param age 年龄
	*/
	public void eat(String name,int age){
		
	}
}

javadoc初次使用

  • 生成文档
javadoc -d myHello -author -version HelloWorld.java

11_初识Java_注释及javadoc_认识使用

  • 参看生成的文档文件
    11_初识Java_注释及javadoc_认识使用

  • 打开文档查看
    11_初识Java_注释及javadoc_认识使用

  • javadoc参数说明

用法: javadoc [options] [packagenames] [sourcefiles] [@files]
  -overview <file>                 从 HTML 文件读取概览文档
  -public                          仅显示 public 类和成员
  -protected                       显示 protected/public 类和成员 (默认值)
  -package                         显示 package/protected/public 类和成员
  -private                         显示所有类和成员
  -help                            显示命令行选项并退出
  -doclet <class>                  通过替代 doclet 生成输出
  -docletpath <path>               指定查找 doclet 类文件的位置
  -sourcepath <pathlist>           指定查找源文件的位置
  -classpath <pathlist>            指定查找用户类文件的位置
  -cp <pathlist>                   指定查找用户类文件的位置
  -exclude <pkglist>               指定要排除的程序包列表
  -subpackages <subpkglist>        指定要递归加载的子程序包
  -breakiterator                   计算带有 BreakIterator 的第一个语句
  -bootclasspath <pathlist>        覆盖由引导类加载器所加载的
                                   类文件的位置
  -source <release>                提供与指定发行版的源兼容性
  -extdirs <dirlist>               覆盖所安装扩展的位置
  -verbose                         输出有关 Javadoc 正在执行的操作的信息
  -locale <name>                   要使用的区域设置, 例如 en_US 或 en_US_WIN
  -encoding <name>                 源文件编码名称
  -quiet                           不显示状态消息
  -J<flag>                         直接将 <flag> 传递到运行时系统
  -X                               输出非标准选项的提要

通过标准 doclet 提供:
  -d <directory>                   输出文件的目标目录
  -use                             创建类和程序包用法页面
  -version                         包含 @version 段
  -author                          包含 @author 段
  -docfilessubdirs                 递归复制文档文件子目录
  -splitindex                      将索引分为每个字母对应一个文件
  -windowtitle <text>              文档的浏览器窗口标题
  -doctitle <html-code>            包含概览页面的标题
  -header <html-code>              包含每个页面的页眉文本
  -footer <html-code>              包含每个页面的页脚文本
  -top    <html-code>              包含每个页面的顶部文本
  -bottom <html-code>              包含每个页面的底部文本
  -link <url>                      创建指向位于 <url> 的 javadoc 输出的链接
  -linkoffline <url> <url2>        利用位于 <url2> 的程序包列表链接至位于 <url> 的文档
  -excludedocfilessubdir <name1>:.. 排除具有给定名称的所有文档文件子目录。
  -group <name> <p1>:<p2>..        在概览页面中, 将指定的程序包分组
  -nocomment                       不生成说明和标记, 只生成声明。
  -nodeprecated                    不包含 @deprecated 信息
  -noqualifier <name1>:<name2>:... 输出中不包括指定限定符的列表。
  -nosince                         不包含 @since 信息
  -notimestamp                     不包含隐藏时间戳
  -nodeprecatedlist                不生成已过时的列表
  -notree                          不生成类分层结构
  -noindex                         不生成索引
  -nohelp                          不生成帮助链接
  -nonavbar                        不生成导航栏
  -serialwarn                      生成有关 @serial 标记的警告
  -tag <name>:<locations>:<header> 指定单个参数定制标记
  -taglet                          要注册的 Taglet 的全限定名称
  -tagletpath                      Taglet 的路径
  -charset <charset>               用于跨平台查看生成的文档的字符集。
  -helpfile <file>                 包含帮助链接所链接到的文件
  -linksource                      以 HTML 格式生成源文件
  -sourcetab <tab length>          指定源中每个制表符占据的空格数
  -keywords                        使程序包, 类和成员信息附带 HTML 元标记
  -stylesheetfile <path>           用于更改生成文档的样式的文件
  -docencoding <name>              指定输出的字符编码
上一篇:01.java基础知识


下一篇:04.JavaDoc