2-7:如何在java中使用注释

1.什么是注释?

  • 用以描述某段代码的作用。

2.注释的三种类型:

  • 单行注释、多行注释、文档注释。如下图所示:

3.我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档。

4.打开首页,查看下生成的 API 文档:

PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:

扫描二维码关注公众号,回复: 5940184 查看本文章

       @author 标明开发该类模块的作者

       @version 标明该类模块的版本

       @see 参考转向,也就是相关主题

       @param 对方法中某参数的说明

       @return 对方法返回值的说明

       @exception 对方法可能抛出的异常进行说明

猜你喜欢

转载自www.cnblogs.com/zwh820672664/p/10732435.html
2-7