斜杠_用于_文档_注释

建议使用 /// 作为文档注释。

此规则适用于 Dart 2.0 及更高版本。

规则集：推荐，flutter

此规则提供 快速修复。

来自 有效 Dart

使用 /// 作为文档注释。

尽管 Dart 支持两种文档注释语法（/// 和 /**），但我们建议使用 /// 作为文档注释。

良好

/// Parses a set of option strings. For each option:
///
/// * If it is `null`, then it is ignored.
/// * If it is a string, then [validate] is called on it.
/// * If it is any other type, it is *not* validated.
void parse(List options) {
  // ...
}

在文档注释中，可以使用 Markdown 进行格式化。

要启用 slash_for_doc_comments 规则，请在 linter > rules 下添加 slash_for_doc_comments 到你的 analysis_options.yaml 文件中

linter:
  rules:
    - slash_for_doc_comments

除非另有说明，本网站上的文档反映了 Dart 3.5.3。页面最后更新于 2024-07-03。 查看源代码 或 报告问题.