java注释总结

注释详细解释

---

为什么需要注释

---

​

• 平时我们自己编写的代码比较少的时候我们是可以直接看懂的,但是当我们的代码的数量不断的增大的时候,我们就需要注释俩帮助我们具体的操作的思路
• 需要明确的是注释是不会被执行的 ,它是给程序员看的
• 书写注释是一个很重要的习惯 ,利人利己
  • 我们也可以用注释进行简单的程序的调试

java中的注释的种类有什么

---

• 单行注释

• 多行注释

• 文档注注释

  java中的注释的种类有什么

不同注释的的格式

---

1. 单行注释的格式 //开头 后面放置注释的内容 只可以注释一行的内容
2. 多行注释 /* 注释的内容 */ 多行注释可以注释多行的内容
3. 文档注释的格式 /** 注释的内容 */ 用于生成帮助文档
4. 文档注释 中是可以放置不同的注解

javaDoc常见的注解的含义

---

/**
     * @Description 对于代码的描述
     * @Author 表示的是作者的意思
     * @param args 放置的是你的参数
     * @return 返回值
     * @throws 需要抛出的异常
     * @since 表示的是你当前使用的jdk的版本
     * @exception 异常处理
     */