java中的注释（Comment）

java中的注释分为三种

1. 单行注释

// 这是单行注释的内容，以 // 开头

2. 多行注释

/* 
 这是多行注释，
*/

3. 文档注释

/**
 * @author yichang
 * @version 1.0.0
 */

文档注释，会被编译，单行和多行注释不会被编译

package com.yichang.java.comment;

/**
 * @author yichang
 * @version 1.0.0
 */
public class JavaComment {

    /**
     * 这是main方法，程序的入口
     * @param args
     */
    public static void main(String [] args) {
       // 下面是输出语句
        System.out.println("java注释用法");
        /*
         这是
         多行
         注释
        */
    }
}

例如这个文件。在当前JavaComment.java目录下输入

javadoc JavaComment.java
// 或者。指定输出的目录
javadoc JavaComment.java  目录

java程序就会自动帮你输出doc文档

图片.png

编译完成之后。在当前JavaComment.java文件的根目录下就会生成很多文件。
如下图：

图片.png

打开index.html。就可以查找文档的内容了。

附上doc的标签

标签	描述	示例
@author	标识一个类的作者	@author yichang
@deprecated	指名一个过期的类或成员	@deprecated 这是一个过时的方法
@exception	标志一个类抛出的异常	@exception 此方法可能会出现IO异常
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info