2.3 注释与文档
良好的代码段注释以及文档注释可以提高代码的可读性，也是非常必要的，我们要养成随时注释的习惯，在注释时，也需要按照一定的标准进行说明。力求简洁、一致。
本标准的注释参考了Effective Dart | Documentation中的相关内容。
注释
推荐：涉及功能的代码段使用注释进行说明
当部分代码段的功能比较复杂，需要注释进行补充时，请使用简短的注释表示代码段执行的逻辑。
推荐：对声明的局部变量使用注释进行说明
当一个局部变量需要进行注释补充时，请使用简短的注释表示局部变量的内容以及用途。
文档
在dart语言中，文档注释是用来补充说明类、变量或者函数的补充文本。良好的文档注释可以提高代码的可读性，同时，对于向外提供的公共接口，完整的文档注释是有必要的，因此，在进行文档注释时，我们需要说明：
- 类或者函数的功能简单说明。
- 需要说明的函数的说明、以及参数类型。
- 返回值的说明。
- 需要参考引用的类或者说明。
我们既需要保证注释的完整性以及简洁性。同时，也应当尽量减少不必要的注释。
强制：使用///来表示文档注释
在每行的开头使用///来表示文档注释（C# style），不使用/** ... */（Java style）来表示文档注释。
/// entity class User.
class User {
...
}
推荐：使用[]来对注释进行引用
使用[]可以引用代码中已经存在的类、函数或者变量，当代码需要相关的标识进行说明时，采用[]链接可以提高注释的可读性。
/// To create a point, call [Point.new] or use [Point.polar] to ...
