Closed
Description
Effective Dart says:
For historical reasons, dartdoc supports two syntaxes of doc comments:
///
(“C# style”) and/** ... */
(“JavaDoc style”). We prefer///
because it’s more compact./**
and*/
add two content-free lines to a multiline doc comment. The///
syntax is also easier to read in some situations, such as when a doc comment contains a bulleted list that uses*
to mark list items.If you stumble onto code that still uses the JavaDoc style, consider cleaning it up.
The analyzer codebase contains a mixture of the ///
and /** ... */
syntaxes. We should clean it up so that it follows the recommendations of Effective Dart.