java代码自注释（java开发中的注解自定义详解）

本篇文章给大家谈谈java代码自注释，以及java开发中的注解自定义详解对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。

本文目录一览：

• 1、java 怎样给源代码添加注释
• 2、java 中的几种注释方式
• 3、java中如何自动生成注释

java 怎样给源代码添加注释

1、单行(single-line)--短注释：//……

单独行注释：在代码中单起一行注释，

注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。

注释格式：/*

注释内容

*/

行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。

注释格式：//

注释内容

行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。

注释格式：代码

+

8（至少4）个空格

+

//

注释内容

2、块(block)--块注释：/*……*/

注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成：

/*

*

注释内容

*/

3、文档注释：/**……*/

注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符

/**......*/

...

java 中的几种注释方式

我看动力节点的java基础大全301集教中的三种注释方法：

1、单行注释   //注释的内容

2、多行注释  /*......*/

3、/**......*/，这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍一下Javadoc的标记：

特别声明：

（1）javadoc针对public类生成注释文档

（2）javadoc只能在public、protected修饰的方法或者属性之上

（3）javadoc注释的格式化：前导*号和HTML标签

（4）javadoc注释要仅靠在类、属性、方法之前

下面主要举例说明第三种注释的应用：

（1）首先编写.java文件

（2）在命令行中执行以下dos命令：

javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档

//javadoc标记：是@开头的，对javadoc而言，特殊的标记。

（3）在当前目录下就会产生doc文件夹，里面有一系列的.html文件

附上代码：

[java] view plain copy

span style="font-size:18px;"*/

/**javadoc注释的内容

*/

public class Hello{

/**属性上的注释*/

public String name;

/**这是main方法,是程序的入口

*@param args 用户输入参数

*/

public static void main(String[] args){

System.out.println("Hello World!");

f1();

}

/** 这是第1个方法,其作用是...*/

public static void f1(){

System.out.println("f1()！");

}

}/span

[java] view plain copy

span style="font-size:18px;"import java.io.IOException;

/**javadoc注释内容

*@since 1.0

*@version 1.1

*@author Blue Jey

*br链接到另一个文档{@link Hello},就这些

*see Hello

*/

public class HelloWorld{

/**非public，protected 属性上的注释不生成*/

public String name;

/**这是main方法，是程序的入口

*@param args 用户输入的参数，是数组

*@throws IOException main方法io异常

*/

public static void main(String args[]) throws IOException{

System.out.println("hello World!");

f1();

f2(1);

}

/**这是第一个方法，其作用是....

*@deprecated 从版本1.2开始，不再建议使用此方法

*/

public static void f1(){

System.out.println("fl()!");

}

/**这是第二个方法，其作用是....

*@return 返回是否OK

*@param i 输入参数i

*@see Hello

*@throws IOException io异常

*/

public static String f2(int i)throws IOException{

System.out.println("f1()!");

return "OK";

}

} /span

注意：

如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version -author

javadoc -version -author -d doc *.java

（其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息）

java中如何自动生成注释

你说的应该是生成javadoc吧?

最简单方式就是使用命令行, cd到你的项目源代码目录下, 输入如下指令:

javadoc -d docs -subpackages com.yourpackage

其中-d docs指定了生成的javadoc在相对目录docs下, -subpackages com.yourpackage指定了你要被生成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                           不显示状态消息

  -Jflag                         直接将 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              指定输出的字符编码

关于java代码自注释和java开发中的注解自定义详解的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。