java基础——JavaDoc

最新推荐文章于 2025-12-22 15:57:21 发布

原创最新推荐文章于 2025-12-22 15:57:21 发布 · 113 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #编程语言

JavaSE 专栏收录该内容

23 篇文章

订阅专栏

这篇博客介绍了如何使用JavaDoc命令来创建自定义的API帮助文档。示例中展示了JavaDoc注释的用法，包括@author、@version、@since等标签，并提供了`Demo08`类的`test`方法作为例子。通过执行`javadoc`命令，可以将这些注释转化为格式化的文档。

JavaDoc

Java API 1.6_Java API中文文档_Java API文档在线 - Java中文网 (javaweb.cc)

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

/**
 * @author 王旭阳  姓名
 * @version 1.0 版本
 * @since 1.8 jdk版本
 */
public class Demo08 {
    String name;

    /**
     *
     * @param name 参数名
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}