文档注释使用javadoc工具生成自己的api帮助文档

最新推荐文章于 2024-08-12 20:46:24 发布

coc_k

最新推荐文章于 2024-08-12 20:46:24 发布

阅读量2.7k

点赞数

分类专栏： java开发文章标签：文档注释 javadoc api文档

本文链接：https://blog.csdn.net/coc_k/article/details/52335430

版权

java开发专栏收录该内容

1 篇文章 0 订阅

订阅专栏

在java开发中定义类、方法时可以添加文档注释，用 javadoc 工具来生成自己的 API 文档。

文档注释以斜线后紧跟两个星号（/**）开始，以星号后紧跟一个斜线（*/）结束

下面是测试类： aTest类。包名是cock

    package cock;
    /**
     * Description:
     * <br/>我的博客: <a href="http://blog.csdn.net/coc_k">coc_k的博客</a>
     * <br/>类的说明:此类为测试 文档注释 所用
     * <br/>Date:2016/8/27
     * @author coc_k
     * @version 1.0
     */
    public class aTest
    {
            /**
             * 简单测试成员变量
             */
            protected String name;
            /**
             * 主方法，程序的入口
             */
            public static void main(String[] args)
            {
                    System.out.println("Hello World!");
            }
    }

在写一个测试类：bTest类。包名是cock2

    package cock2;

    /**
     * Description:
     * <br/>我的博客: <a href="http://blog.csdn.net/coc_k">coc_k的博客</a>
     * <br/>类的说明:此类为测试 文档注释 所用
     * <br/>Date:2016/8/27
     * @author coc_k
     * @version 1.0
     */
    public class bTest
    {
            /**
             * 简单测试成员变量
             */
            public int age;
            /**
             * Test类的测试构造器
             */
            public bTest()
            {
            }
    }

在写一个测试类：cTest类。包名也是cock2

    package cock2;

    /**
     * Description:
     * <br/>我的博客: <a href="http://blog.csdn.net/coc_k">coc_k的博客</a>
     * <br/>类的说明:此类为测试 文档注释 所用
     * <br/>Date:2016/8/27
     * @author coc_k
     * @version 1.0
     */
    public class cTest
    {
            /**
             * 一个得到打招呼字符串的方法。
             * @param name 该参数指定向谁打招呼。
             * @return 返回打招呼的字符串。
             */
            public String hello(String name)
            {
                    return name + "，你好！";
            }
    }

以上测试类的特点是:

aTest类的包名是cock
bTest类和 cTest类的包名是cock2

新建两个文件夹: cock和cock2

将文件aTest.java放入文件夹cock中
将文件bTest.java和cTest.java放入文件夹cock2中

为了生成包的注释，我们还需在cock文件夹中加一个包描述符文件 package.html

    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
    <HTML>
     <HEAD>
      <TITLE></TITLE>
    </HEAD>
    <BODY>
    在这里写上对包cock的注释
     </BODY>
    </HTML>

在两个文件夹处所在目录下打开控制台，输入指令

javadoc -d apidoc -windowtitle 测试 -doctitle 学习javadoc的测试API文档 -header 我的类 -version -author cock cock2

此时就生成了自己的api帮助文档

在文件夹cock所在目录生成文件夹apidoc,打开此文件夹下的index.html文件，查看生成的api文档

这里写图片描述

自己写的源码可以生成api文档，太酷了！

内容来自：疯狂java讲义第三版

coc_k

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录