下面的提示适用于不被生成在文档中的注释。

要像句子一样来格式化注释。

  1. // Not if there is nothing before it.
  2. if (_chunks.isEmpty) return false;

如果第一个单词不是大小写相关的标识符，则首字母要大写。（中文注释不作要求）使用句号，叹号或者问号结尾。所有的注释都应该这样：文档注释，单行注释，甚至 TODO。即使它是一个句子的片段。

不要使用块注释作用作解释说明。

  1. greet(name) {
  2.   // Assume we have a valid name.
  3.   print('Hi, $name!');
  4. }
  1. greet(name) {
  2.   /* Assume we have a valid name. */
  3.   print('Hi, $name!');
  4. }

可以使用块注释 (/* ... */) 来临时的注释掉一段代码，但是其他的所有注释都应该使用 //。