Java的注释

Java的注释

平时我们编写代码，在代码量较少时可以，我们可以看懂自己写的，但是项目结构一旦复杂起来，我们就需要用到注释了。

注释并不会被执行，是给我们写代码的人看的

书写注释是一个非常好的习惯

java中的注释有三种：

• 单行注释
• 多行注释
• 文档注释

JavaDoc

• javadoc 命令是用来生成自己的API文档的
• 参数信息：
  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况