如何在Flutter中为Widget及其参数添加说明文档？

你需要的IDE悬浮提示效果，通过Dart标准的文档注释规则即可实现，无需额外配置，按以下规范编写注释即可生效：

1. 基础注释规则 #

• 所有文档注释使用三个斜杠 /// 开头，区别于普通代码注释的双斜杠
• 优先编写Widget本身的功能描述，再对每个构造参数单独做说明
• 可以用方括号 [] 引用关联的类、参数、方法，IDE会自动生成关联跳转
• 注释内容支持Markdown格式，加粗、列表、代码块都可以被IDE正常识别渲染

2. 代码示例 #

/// 自定义圆角填充按钮组件
/// 
/// 支持自定义背景色、文字内容、点击回调，自带圆角阴影效果，适用于页面主操作按钮场景
/// 
/// 调用示例：
/// ```dart
/// CustomFilledButton(
///   text: "提交表单",
///   onPressed: () => submitInfo(),
///   backgroundColor: Colors.blue,
/// )
/// ```
class CustomFilledButton extends StatelessWidget {
  const CustomFilledButton({
    super.key,
    /// 按钮显示的文字内容，参数不可为空
    required this.text,
    /// 按钮点击时触发的回调，传null时按钮自动进入禁用状态
    required this.onPressed,
    /// 按钮背景色，默认取当前主题的primaryColor主色
    this.backgroundColor = Colors.blue,
    /// 按钮圆角半径，默认值为8dp
    this.borderRadius = 8,
  });

  final String text;
  final VoidCallback? onPressed;
  final Color backgroundColor;
  final double borderRadius;

  // 组件实现逻辑省略
}

3. 效果说明 #

注释编写完成后，在其他位置调用该Widget、光标悬停在组件名或参数上时，Android Studio、VS Code等IDE都会自动弹出对应的说明面板，包含组件功能描述、参数含义、示例代码等内容，和Flutter官方组件的提示效果完全一致。

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