Skip to content

Files

Latest commit

 

History

History
25 lines (18 loc) · 660 Bytes

slash_for_doc_comments.md

File metadata and controls

25 lines (18 loc) · 660 Bytes

Pattern: Missing use of /// for doc comment

Issue: -

Description

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

Example of correct code:

/// 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.

Further Reading