虽然微不足道但是很有用的JAVA基础—注释与文档标记

萌新的入门总结，欢迎指正各种错误~ ~

引：最讨厌自己写注释，最讨厌别人不写注释  ~ ~

我理解的注释有两个作用：

1.让自己明白自己的某一块代码是用来干什么的 ，因为写的多了，或者时间久了，总会忘记之前写的功能是什么，有注释也可以帮助自己更快的回忆这部分代码的功能。

2.让别人读得懂你的代码，未来的项目大多都不是你自己一个人再写，偶尔有别的事，需要别人来维护你写过的代码，那么注释就起到了关键的作用。

个人觉得：注释应该尽可能写的简短明了，起到注释改起的作用就行

注释分为三种注释

1.单行注释（//    ）：我多用于注释一些定义的变量或者常量名。

2.多行注释（/* */）：多用于注释一些简单的方法（其实方法名本身就应该体现其功能，做方法注释我倒觉得不是特别必要，只有参数比较不常见，我可能会注释一下，个人意见）。

3.文本注释（/** */）：文本注释我一般写在类的开头，用来标注这个类的作用，以及稍微提一下里面的一些方法。

偶尔我们会遇到一些@开头的标识符，是官方声明好的具有特定含义的标记，这类标记我们称之为文档标记，不同的标记代表着不同的含义。（可能理解上有误差，欢迎指正）

简单介绍一下几种标记以及其功能（临时去查了查百度）

@version 版本信息 ， 对于版本 ，我的印象就是 每次更改应该会改变被标记的值

@author 作者信息， 提供作者的相关信息吧？

@since 指定被标记的内容最早出现在哪个版本

@see 生成参考其他doc的连接

@link 功能同上，区别在于@link能在注释中起作用

@deprecated 用于标记该内容即将或者已经过时

@param 描述方法的参数

@return 描述返回值

@throws 描述异常