JAVADOC

最新推荐文章于 2024-09-30 10:36:33 发布

斩魂学习之路

最新推荐文章于 2024-09-30 10:36:33 发布

阅读量279

点赞数

文章标签： javadoc java

本文链接：https://blog.csdn.net/m0_47113200/article/details/121797803

版权

Java Doc

每日名言

一个胜利者不会放弃，而一个放弃者永远不会胜利。——励志名言

javadoc 命令是用来生成自己API文档的
参数信息
1. @author 作者名
2. @version 版本号
3. @since 指明需要最早使用的jdk版本
4. @param 参数名
5. @return 返回值情况
6. @throws 异常抛出情况
jdk帮助文档 1.8 帮助文档

package com.zhuanhun.operater;

/**
 * @author zhuanhun
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    //属性
    String name;

    //自动生成 1
    /**
     *
     * @param name
     * @return
     */

    //自动生成 2

    /**
     * @author zhuanhun
     * @param name
     * @return
     * @throws Exception
     */

    //方法
    public String test(String name) throws Exception{
        return name;
    }

}

代码中敲出“/**”会自己弹出。
基础知识一定牢记以后每天都会用
通过命令行产生javaDoc文档
1. 首先在IDEA中找一个文件右击出现 Open in 在里面找Explorer 在最上面地址栏最前面加“空格 cmd 空格”
2. 在输入javadoc -encoding UTF-8 -charset UTF-8 DOC.java
3. 回车就会生成 .html 的文件。