slash_for_doc_comments

Group: style

Maturity: stable

Dart SDK: >= 2.0.0 • (Linter v0.1.1)

flutter pedantic

View the Project on GitHub dart-lang/linter

From the style guide:

PREFER using /// for doc 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.