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() {}
Was this page's content helpful?
Thank you for your feedback!
Provide details Thank you for your feedback! Please let us know what we can do to improve.
Provide details Unless stated otherwise, the documentation on this site reflects Dart 3.8.1. Page last updated on 2025-05-08. View source or report an issue.