Java注释

为什么要写注释?(个人看法)

  • 记录一下代码实现的思路,方便日后查看
  • 帮助团队协作开发
  • 使别人了解代码的结构和功能
  • 可以了解到代码什么时候更新了,更新了什么
  • 代码是谁负责的

Java的注释一共分为三种,分别是单行注释、多行注释、文档注释。

单行注释

单行注释使用//标注。

// 计算两个整数的和
public static int sum(int a, int b) {
     return a + b;
}

多行注释

多行注释使用/* */标注。
多行注释不能嵌套使用。

  /*
   这是一个函数
   用来计算两个整数的和
   */
   public static int sum(int a, int b) {
       return a + b;
   }

文档注释

文档注释可以注释多行内容,通常用来生成文档。
使用/** */来标注。

/**
* @author hllog
* @since 1.8
* @param a
* @param b
* @return The sum of two numbers
*/
public static int sum(int a, int b) {
	return a + b;
}

命令行生成

javadoc -encoding UTF-8 -charset UTF_* Demo.java

idea生成

  1. Tools
  2. Generate JavaDoc
  3. 进行参数配置
  4. 点击OK即可生成文档
posted @ 2021-10-22 17:15  hllog  阅读(44)  评论(0)    收藏  举报