javadoc 与 api文档

最新推荐文章于 2024-05-31 10:46:10 发布

李Qiankun

最新推荐文章于 2024-05-31 10:46:10 发布

阅读量38

点赞数 1

文章标签： java

本文链接：https://blog.csdn.net/m0_67020748/article/details/133972300

版权

写代码一定要写注释，阅读性是排在第一位的。

java的文档注释（/** 内容 */）帮助我们生成文档，通过阅读文档快速了解的类、接口等的具体作用。

官方文档地址（以java 17 为例）

https://www.oracle.com/java/technologies/javase-jdk17-doc-downloads.html

要不用这个吧 Java17中文文档 - API参考文档 - 全栈行动派

我准备了两个包、三个类，结构如下。

ClassRoom类

ClassRoom类写得多，其他的只是为了表示结构

package pac1;

/**
 * Description: 这是一个教室类，用于构造教室类对象<br>
 * Other: 这是一份使用javadoc生成API文档的练习<br>
 * Date: 2023年10月22日<br>
 * Time: 2023年10月22日13:21:50<br>
 * @author Li Qiankun
 * @version java 17
 * @see "疯狂java讲义"
 */
public class ClassRoom {
    /**
     * 私有、字符串类型变量，描述教室种类
     */
    private String type;


    /**
     * 有参构造器
     * @param type 教室类
     */
    public ClassRoom(String type) {
        this.type = type;
    }

    /**
     * 无返回值，描述教室包含的东西
     */
    public void contains(){
        System.out.println(type + ", 这个教室里有桌椅、讲台、黑板");
    }

    /**
     * 这是main方法，在栈中运行，main是一切主程序的开端
     * @param args 字符串数组的变量名
     */
    public static void main(String[] args) {
        ClassRoom classRoom = new ClassRoom("普通教室");
        classRoom.contains();
    }
}