java基础_04_java Doc

1、java Doc

 

/**
 * @author xiaodi
 * @version 1.0
 * @since 1.8
 */
//以上是加在类上的注释
public  class helloworld {
    String name;

    /**
     * 
     * @param name
     * @return
     * @throws Exception
     */
    public  String test(String name) throws Exception{
        return name;

        //以上是加在方法上的注释
    }
}

 

2、使用cmd,命令，生成java.Doc文档,把代码生成可读性文档

先在文件中打开

 

 javadoc命令： javadoc -encoding UTF-8 -charset UTF-8 Doc.java

 

 

3、使用IDER 生成Java.Doc文档