利用javadoc生成API文档

最新推荐文章于 2023-06-29 21:54:09 发布

FIRE_TRAY

最新推荐文章于 2023-06-29 21:54:09 发布

阅读量547

点赞数

分类专栏： Java 文章标签： java javadoc

本文链接：https://blog.csdn.net/fire_tray/article/details/48295479

版权

Java 专栏收录该内容

85 篇文章 0 订阅

订阅专栏

利用javadoc生成API文档

参考文献：《疯狂Java讲义》

何为文档注释

以“/**”开始，“*/”结束

/**
 *Description:
 *<br>This is the Main Class which contains the main method
 *<br>website: <a href="http://www.baidu.com">www.baidu.com</a>
 * 
 * @author FIRE_TRAY fire_tray@foxmail.com
 * @version 1.0
 */

public class Main
{
    /**
     * the ret String
     */
    public static String s = "HelloWorld";

    /**
     * the entrance of this Java application
     * @param args the arguments passed from the console command
     */
    public static void main(String[] args)
    {
        System.out.println(s);
    }
}

由于文档注释用于生成API文档，而API文档住哟啊用于说明类、方法、成员变量的功能，因此JavaDoc工具处理源文件在类、接口、方法成员变量、构造器和内部类之前的注释，忽略其他地方的文档注释。而且javadoc工具默认只处理以public或protected修饰的class,interface,method,成员变量,constructor和内部类之前的文档注释。

—如果开发者希望将private的注释暴露给使用者，可以在使用javadoc工具时增加-private选项