Java文档注释记

  用户应该在编写代码的同时添加适当的文档注释,这样在代码编写、测试完成后可以直接通过JDK提供的javadoc.exe工具将源代码中的文档注释提取成一份标准的API文档。
   Javadoc默认只处理用public、protected修饰的类、接口、构造方法、方法、属性、内部类之前的文档注释。

  1. 文档注释中常用的Html标签
      超链接:<a href=”http://www.sohu.com">< /a>
      段落:< p > </ p>
      回车:< br/>
      加粗:< b>< /b>
    2.类或接口前的文档注释
      @author:作者
      @version:程序版本
      @since:从指定JDK版本开始。
      @see:参见可能会关心的类或接口。
    3.方法或构造方法前的文档注释
      @param:形式参数说明信息,建议一个形式参数占一行。
      @return:方法的返回参数类型说明信息。
      @throws:与@exception相同,方法可能抛出的异常信息说明。
      @deprecated:指示该方法已经过时,不推荐使用。
      @see:参见其他方法。
      @link:指向其他Html文档的链接。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值