首页 / JAVA / Java基础12：JavaDoc生成文档

Java基础12：JavaDoc生成文档

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了Java基础12：JavaDoc生成文档，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含771字，纯文字阅读大概需要2分钟。

内容图文

Java基础12：JavaDoc生成文档

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

参数信息：

  1. @author 作者名
  2. @version 版本号
  3. @since 指明需要最早使用的jdk版本
  4. @param 参数名
  5. @return 返回值情况
  6. @throws 异常抛出情况

代码部分：

        package com.pzz.base;

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

    String name;

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

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

    //作业：学会查找使用IDEA生成JavaDoc文档！  面向百度编程
    
    //基础部分的一切知识，后面几乎每天都会用
}

用IDEA生成javadoc文档：https://blog.csdn.net/weixin_42140580/article/details/89635775

步骤：

技术分享图片

  1. 选择整个项目还是模块还是单个文件
  2. 文档输出路径
  3. Locale选择地区，这个决定了文档的语言，中文就是zh_CN
  4. 传入JavaDoc的参数，一般这样写-encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

原文：https://www.cnblogs.com/PZZzuel/p/15068411.html

内容总结

以上是互联网集市为您收集整理的Java基础12：JavaDoc生成文档全部内容，希望文章能够帮你解决Java基础12：JavaDoc生成文档所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/1203237.html

来源：【匿名】