如何在Java中使用注释

在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。

一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!

Java 中注释有三种类型:单行注释、多行注释、文档注释

如何在Java中使用注释_第1张图片

运行结果:Hello Imooc!

看:被注释的代码块在程序运行时是不会被执行的~~

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

如何在Java中使用注释_第2张图片

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

如何在Java中使用注释_第3张图片

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

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

@version 标明该类模块的版本

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

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

@return 对方法返回值的说明

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

你可能感兴趣的:(如何在Java中使用注释)