注释

Dart 提供了三种类型的注释，用于解释代码、提高代码的可读性，以及生成文档。

单行注释

• 以 // 开头，注释从 // 到行尾的内容。
• 常用于对单行代码或块代码中的某个细节进行简单说明。

示例：

void main() {
  // 打印一条简单的问候语
  print('Hello, Dart!');
}

多行注释

• 使用 /* ... */ 包围的内容作为注释，可以跨多行。
• 常用于对代码块、复杂逻辑或模块进行详细说明。

示例：

void main() {
  /*
   * 这个函数用于演示 Dart 中的多行注释
   * 它会打印一个简单的问候语
   */
  print('Hello, Dart!');
}

文档注释

• Dart 支持文档注释，用于生成文档（如通过工具 dartdoc）。
• 单行文档注释以 /// 开头。
• 多行文档注释以 /** 开头，以 */ 结尾。
• 常用于类、方法、函数或变量的描述。

示例：

1. 单行文档注释：

   /// 打印问候语
   void greet() {
     print('Hello, World!');
   }

2. 多行文档注释：

   /**
    * 这是一个 Person 类
    * 包含姓名和年龄的基本信息
    */
   class Person {
     String name;
     int age;
   
     Person(this.name, this.age);
   
     /// 获取详细信息
     String getDetails() => 'Name: $name, Age: $age';
   }

综合示例

/**
 * 计算两个数字的和
 *
 * [a] 第一个数字
 * [b] 第二个数字
 * 返回两数之和
 */
int add(int a, int b) {
  // 将两个数字相加并返回
  return a + b;
}

void main() {
  // 调用 add 函数并打印结果
  print(add(10, 20)); // 输出: 30
}