Java编写注释相关

最近发觉自己不爱写注释的习惯，决定改过自新，从今天开始学习写注释，争取每段代码都写上注释。

注释分为三种类型：

1.单行注释：

写法：

在一行的最前面写：//  +需要书写的注释

图例：

2.多行注释：

写法：

在任意位置写：/*  + 需要书写的注释 +*/

图例：

 

3.说明注释：

写法：

在类或者方法头部写：

以 /** 开始，以 */结束，中间可以书写标签注解。

说明注释允许你在程序中嵌入关于程序的信息。

还可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。

说明注释，使你更加方便的记录你的程序信息。

 

常用标签：

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

       @version 标明该类模块的版本

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

       @return 对方法返回值的说明

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

 

图例：