标签：return String author JavaDoc 生成 文档 name

JavaDoc

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

参数信息

• @author 作者名
• @version 版本号
• @since 指明需要最早使用的JDK版本
• @param 参数名
• @return 返回值情况
• @throws 异常抛出情况

可以去网上搜JDK帮助文档。

使用 cmd编写 JavaDoc命令

视频时间：4；36

P32Java基础12：JavaDoc生成文档

// cmd内输入代码
javadoc -encoding UTF-8 -charset UTF-8 Doc.java

//对应视频Doc

/**
 * @author kuangshen
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

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

    //通过命令行（cmd）：javadoc 参数 Java文件

    //学会查找使用 IDEA生产 JavaDoc文档！    面向百度编程！

    //基础部分的一切知识，后面几乎每天都会用。

}

使用 IDEA生产 JavaDoc文档

1. 打开 idea，点击 Tools–> Generate JavaDoc，会弹出生成JavaDoc文档的配置页面。
   
   

2. 进行参数配置
   
   

3. 在输出目录里生成JavaDoc。
   
   

   
   

标签：return,String,author,JavaDoc,生成,文档,name
来源： https://www.cnblogs.com/wanjiaxin/p/JavaDoc.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。