JavaDoc生成文档

2021-03-03 13:28

阅读:310

标签:lang   ring   img   pre   api文档   异常抛出   文档   ado   api   

JavaDoc

  • javadovc命令是用来生成自己API文档的

    • javadoc -encoding UTF-8 -charset UTF-8 文件名.java
  • 参数信息

    • @author 作者名
    • @version 版本号
    • @since 指明需要最早使用的jdk版本
    • @param 参数名
    • @return 返回值情况
    • @throws 异常抛出情况
    package com.kuang.base;
    
    /**
     * @author wk
     * @version 1.0
     * @since 1.8
     */
    
    public class Doc {
    
        String name;
    
        /**
         * @author wk
         * @param name
         * @return
         * @throws Exception
         */
    
        public String test(String name) throws Exception{
            return name;
        }
    }
    
    

在IDEA中生成JavaDoc文档

  • Tools–>Generate JavaDoc

    技术图片

  • 填入配置

    技术图片

JavaDoc生成文档

标签:lang   ring   img   pre   api文档   异常抛出   文档   ado   api   

原文地址:https://www.cnblogs.com/AIKangK/p/14392676.html


评论


亲,登录后才可以留言!