Java的文档注释(帮助文档)错误教训

1、有主函数main的class类应该与需要注释的方法的class分开写,要不然在cmd时会出现无此class也就是我们需要注释的文件找不到。

解决:当需要注释的不是含有主函数的类时需要类名分开保存,这样就可以避免找不到的文档化的类了。 

 

2、需要加public,因为是分开写的所以我们需要注释的类的无法运行:

 但是在main的class中可以运行,前提是:

3、注释要规范:(这是我注释不规范报的错误)

 

 @param后面加参数名要单独出来列如:@param x 这个参数代表 

 4、命令规范:(举例)

javadoc -d . -version -author MyTool.java

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值