Flutter/Dart 行内文档注释还有哪些额外的格式化可选方案？

• 标识符引用
  不需要像C#那样用专门的Param、SeeAlso标签，直接用方括号包裹变量、类、方法名即可，IDE会自动关联跳转，生成的文档也会带上对应链接：

  /// 按照 [count] 次遍历 [UserList] 中的数据，调用 [UserDao.delete] 方法清理无效数据
  

• 多行代码块
  可以用三个反引号包裹多行代码示例，还可指定dart语言标记实现语法高亮：

  /// 示例调用：
  /// ```dart
  /// final cleaner = UserCleaner();
  /// cleaner.clearInvalid(10, userList);
  /// ```
  

• 有序列表
  除了无序列表的+/-，还可以用数字加.的格式生成有序列表，适合写步骤类说明：

  /// 调用流程：
  /// 1. 调用 [UserCleaner.init] 完成初始化
  /// 2. 传入要清理的用户列表
  /// 3. 调用 [clearInvalid] 执行清理逻辑
  

• 文本强调
  用单星号包裹文本实现斜体，双星号包裹实现粗体，适合标注重点注意事项：

  /// *注意*：该方法会阻塞IO线程，**禁止**在UI主线程直接调用
  

• 引用块
  用>开头可以生成引用块，适合标注废弃提示、版本说明等内容：

  /// > 该方法已在v2.3.0版本废弃，请替换为 [UserCleaner.clearBatch]
  

• 空行换行
  不需要强制用<br />实现换行，只要在两行注释中间加一行空的三斜杠注释，生成的文档会自动换行，可读性更高：

  /// 第一行说明文本
  ///
  /// 这一行会自动作为新段落显示
  

• 特殊标记高亮
  注释中大写的TODO、NOTE、WARNING等标记，Android Studio会自动识别高亮，方便后续跟进待办：

  /// TODO: 后续支持批量筛选指定类型的用户
  /// NOTE: 仅支持Flutter 3.0及以上版本使用
  

• 特殊字符转义
  要显示*、[、]等和注释语法冲突的字符时，前面加反斜杠\转义即可：

  /// 格式要求：\[用户名\] - 手机号
  

内容的提问来源于stack exchange，提问作者Xenoranger