javadoc自动生成接口文档

本文介绍如何通过在代码中添加特定注释并利用JDK中的javadoc工具来自动生成API文档。详细步骤包括如何指定注释格式及运行命令来生成文档,并解决常见问题如未展示private成员等。

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

利用JDK中的javadoc工具来进行自动生成。

 

1、在需要生成注释的代码上面增加 /**   */  

2、打开cdm,进入当前类的位置,运行 javadoc -d   生成注释文档的目录  Java文件

PS:打开注释文档,用private修饰的方法没有显示出来,用public和protected修的变量和方法都打印出来了,说明被private修饰的数据不可以被展示;

若要打印多个注释文档,直接在后面加:javadoc -d D:\test test.java  test1.java test2.java ...;

上面打印报错是因为没有说明方法里的参数,按照要求加上就可以了:

    /**
    *两数相减
    *@param a 第一个加数
    *@param b 第二个加数
    *@return 返回的是a和b的和
    */

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值