Why this matters
Block comments do not generate proper Dart documentation. Use `///` for documentation comments instead.
Use `///` for documentation instead of block comments to improve tooling support and ensure better formatting in generated docs.
Block comments do not generate proper Dart documentation. Use `///` for documentation comments instead.
Side-by-side examples engineers can pattern-match during review.
void greet(String title) {
/* Assume we have a valid title. */
print('Hi, $title!');
}void greet(String title) {
// Assume we have a valid title.
print('Hi, $title!');
}void greet(String title) {
/* Assume we have a valid title. */
print('Hi, $title!');
}void greet(String title) {
// Assume we have a valid title.
print('Hi, $title!');
}From the same buckets as this rule.
For changes that affect architecture, data models, external APIs, security posture, deployment topology, or cost (>10%), create an ADR in docs/adr/ using the standard template (Context, Decision, Consequences) and link the PR and issue IDs.