【Android开发学Flutter】代码注释

大家都知道代码注释的重要性，Dart 的注释规范传送门： Effective Dart: 文档

Dart注释的类型有三种：单行注释、多行注释和文档注释。

1、单行注释

// ：对代码进行解释说明。

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

2、多行注释

/*....*/：临时注释掉一些代码。

sayWhat(String what) {
    /*
    * Say something
    * */
    print(what);
  }

3、文档注释

/**....*/ 或者 /// （推荐使用 ///）：可以用 dartdoc 来生成代码API文档。

/// Defines a flag.
///
/// Throws an [ArgumentError] if there is already an option named [name] or
/// there is already an option using abbreviation [abbr]. Returns the new flag.
Flag addFlag(String name, String abbr) { ... }

那么，我们什么情况下应该加上注释，应该使用哪种注释呢？下面是我自己的一些见解：

类、函数或方法注释

使用///给类、函数或方法注释。

类成员变量、常量注释

使用//给函数或方法注释。

其他注释

临时注释的代码可以用多行注释/*...*/，其他注释都使用 //，变量、常量、判断和需要说明的代码都应该加上注释。

大家有好的建议请留言。