Skip to main content

slash_for_doc_comments

Use the end-of-line form ('///') for doc comments.

Description

#

The analyzer produces this diagnostic when a documentation comment uses the block comment style (delimited by /** and */).

Example

#

The following code produces this diagnostic because the documentation comment for f uses a block comment style:

dart
/**
 * Example.
 */
void f() {}

Common fixes

#

Use an end-of-line comment style:

dart
/// Example.
void f() {}