slash_for_doc_comments

Prefer using /// for doc comments.

This rule is available as of Dart 2.0.

Rule sets: recommended, flutter

This rule has a quick fix available.

From Effective Dart:

DO use /// for documentation comments.

Although Dart supports two syntaxes of doc comments (/// and /**), we prefer using /// for doc comments.

GOOD:

/// 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) {
  // ...
}

Within a doc comment, you can use markdown for formatting.

To enable the slash_for_doc_comments rule, add slash_for_doc_comments under linter > rules in your analysis_options.yaml file:

linter:
  rules:
    - slash_for_doc_comments

Unless stated otherwise, the documentation on this site reflects Dart 3.5.4. Page last updated on 2024-07-03. View source or report an issue.