文档注释与多行注释的区别


多行注释与文档注释的区别: 多行注释的内容不能用于生成一个开发者文档,
而文档注释 的内容可以生产一个开发者文档。


使用javadoc开发工具即可生成一个开发者文档。
    
    javadoc工具的使用格式:
        
        javadoc -d 存放文档的路径   java的源文件 
    

使用javadoc工具要注意细节:
    1. 如果一个类需要使用javadoc工具生成一个软件的开发者文档,那么该类必须使用public修饰。
    2. 文档注释注释的内容一般都是位于类或者方法的上面的。

写注释的规范:一般单行注释是位于代码的右侧,多行注释与文档注释一般是写在类或者方法的上面的。

 

转载于:https://www.cnblogs.com/xufengyuan/p/6257917.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值