slash_for_doc_comments

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

此规则从 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 规则，请在你的 analysis_options.yaml 文件中的 linter > rules 下添加 slash_for_doc_comments

linter:
  rules:
    - slash_for_doc_comments

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