前言
注释是给代码做解释说明,意在记录当时的思路,让他人看得懂你的代码,避免出现自己看不懂自己代码的现象。
注释类型
Dart编译器会忽略注释的内容。
单行注释(//)
Dart 中单行注释使用//实现,常用于重要代码块的解释说明。
记忆方法:
单行注释使用两个/来注释,第一个/为本行注释的开始,第二个/本行注释的结尾。
示例:
void main() {
// 单行注释
int a = 5;
}
多行注释 (/* */)
Dart 中多行注释使用/* */实现,常用于临时注释代码块。
记忆方法: 多行注释使用/* */来注释,/*作为注释的开始*/作为注释的结束。(结合单行注释 // 记忆就是在其中添加了*)
示例:
void main() {
/* 多行注释
* int a = 5;
* int b = 3;
* b += (a + 4);
* print(b); // 输出:12
*/
/* 多行注释
double c = 3;
double d = 4;
d += (c + 4);
print(d); // 输出:11.0
*/
}
文档注释(/** */或///)
Dart 中文档注释使用/** */或///来实现,主要用于 类、属性、函数、参数、顶级变量的注释。
记忆方法: 文档注释在单行注释上多加一个/(Dart 常用///更加简洁),文档注释/** */在多行注释的基础上多加一个*。
示例:
/// 文档注释
/// 定义一个函数
void text(String s) {
/**
* 文档注释
*
*
*/
print(s);
}
元数据注释
Dart中元数据注释以@符号开始,用于为声明附加额外信息,常用的有@override、@deprecated 。
示例:
@Dprecated('我是元数据注释的内容')
@override
标记待办事项
Dart中使用//TODO:来实现,用于标记等待处理的事项。
示例:
//TODO: 需要完成的事项。
注释作用
优雅的注释可以很好记录思路、便于协作、代码管理。
- 记录思路: 注释可以帮助我们记录所写的代码思路,避免了出现自己都看不懂自己代码的现象。
- 便于协作: 注释可以有效提高他人阅读我们代码能力,从而提高协作能力。
- 代码管理: 注释能够提高我们代码的可读性、可维护性,方便代码的管理。
注释风格
好注释事半功倍,坏注释事倍功半。
- 清晰简洁: 注释应避免冗余和模糊的描述,做到清晰简洁。
- 适度注释: 注释应避免过度注释,避免出现给
hello word注释。 - 保持更新: 注释应实时更新,保持注释与代码的一致性。
总结
Dart中注释类型有单行注释、多行注释、文档注释、元数据注释与标记待办事项。在注释的使用过程中应注意注释风格,让注释发挥出最大的作用。