// Not if there is nothing before it.
if (_chunks.isEmpty) return false;
Capitalize the first word unless it’s a case-sensitive identifier. End it with a period (or “!” or “?”, I suppose). This is true for all comments: doc comments, inline stuff, even TODOs. Even if it’s a sentence fragment.
DON'T
DON’T use block comments for documentation
greet(name) {
// Assume we have a valid name.
print('Hi, $name!');
}
You can use a block comment (/* ... */) to temporarily comment out a section of code, but all other comments should use //.
Comments
DO
DO format comments like sentences
Capitalize the first word unless it’s a case-sensitive identifier. End it with a period (or “!” or “?”, I suppose). This is true for all comments: doc comments, inline stuff, even TODOs. Even if it’s a sentence fragment.
DON'T
DON’T use block comments for documentation
You can use a block comment (
/* ... */
) to temporarily comment out a section of code, but all other comments should use//
.