IDEA之java文档生成

最新推荐文章于 2025-03-16 22:31:09 发布

原创最新推荐文章于 2025-03-16 22:31:09 发布 · 1k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#IDEA之java文档生成

编程语言--java 专栏收录该内容

13 篇文章

订阅专栏

本文介绍如何使用IntelliJ IDEA创建一个简单的Java项目，并通过示例详细展示了如何为Java类及其方法添加Javadoc注释，以便于生成清晰的API文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.打开IDEA编辑器，点击project

2.这里我们只是简单的建立个工作空间，所以就不选任何的选项，点击next

3填上自己的project名称

java注释：

//注释内容

/*注释内容*/快捷键选定要注释内容“shift+Ctrl+/”生成注释，“shift+Ctrl+\”取消

/**

*注释内容

直接上代码：

package ldd.demo.javadoc;
/**
 * 类的说明
 * <p>
 *     javadocDemo 类演示如何生成类的API文档<br>
 *     @author ldd
 *     @version 1.0 ldd 2017.3.11
 * </p>
 */
public class javaDemo {
   /*对于类的公有属性，也要写上相关注释*/
    /**
     * 用于显示一个提示信息
     */
    public final String message="this is a demo for javadocument.";
    /**
     * 这个方法是程序入口，虚拟机载入这个类的时候，
     * 将从这个类开始运行程序
     * @param args commandlines<br>
     */
    public static  void main(String []args){
        javaDemo demo=new javaDemo();
        System.out.println(demo.message);
        System.out.print(demo.upcaseMessage());
        System.out.print(demo.getChars(2,6));
    }

    /**
     * 从message中获取指定的字串
     * @param i 子串的开始下标
     * @param i1  子串的结束目标
     * @return   从开始到结束的子串
     */
    private String getChars(int i, int i1) {
        return message.substring(i,i1);
    }

    /**
     * 将message转化成大写的字符串
     * @return   大写的字符串
     */
    private String upcaseMessage() {
        return message.toUpperCase();
    }

}

运行效果如下：