Java中的注释

单行注释

  • 格式: 以 // 开始,直到这一行的末尾。
  • 作用: 用于写一句话的简单说明,或者在某行代码后面加个简短的备注。
    // 这是单行注释,电脑会忽略这一整行
    int age = 18; // 这也是单行注释,用来解释age变量的含义
    System.out.println(age);

多行注释

  • 格式: 以 /* 开始,以 */ 结束。
  • 作用: 用于写比较长的、需要跨越多行的说明。
  • 常见用途:
    1. 详细描述一个复杂的功能。
    2. 临时“禁用”一大段代码(这在调试时非常有用)。
      /*
      这是一个多行注释。
      我可以在这里写很多行的解释,
      比如,详细说明下面这个方法的功能、
      注意事项等等。
      */
      public void calculatePrice() {
      // ... 复杂的计算逻辑 ...
      }

文档注释

  • 格式: 以 /** 开始(注意,是两个星号),以 */ 结束。
  • 作用: 这是一种特殊的多行注释。它不只是给看代码的人用的,它还可以被Java自带的 javadoc 工具自动提取出来,生成程序的官方使用说明书(API文档)。
  • 特点: 里面经常会用一些特殊的标签(以 @ 开头),比如 @param (说明参数), @return (说明返回值), @author (说明作者)。
posted @ 2025-10-21 18:50  一下叶川  阅读(2)  评论(0)    收藏  举报