【Dart 教程系列第 1 篇】Dart中的单行注释、多行注释、文档注释

这是【Dart 教程系列第 1 篇】，如果觉得有用的话，欢迎关注专栏。

Dart 支持单行注释、多行注释和文档注释。

一：单行注释

单行注释就是只有一行的注释，以 “//” 开头，"//" 后面写注释的内容， 所有在 “//” 和该行结尾之间的内容都会被编译器忽略。

  // 博主名称
  String author = "AllenSu";

二：多行注释

多行注释以 /* 开始， 以 */ 结尾。 所有在 /* 和 */ 之间的内容被编译器忽略 （不会忽略文档注释）。

/*
  这是多行注释
  这是多行注释
  这是多行注释
 */
void test(){

}

多行注释也可以写成一行

/* 这是多行注释 */
void sum(){

}

不过我个人比较喜欢下面这种写法，即每行注释前面有个 *

/*
 * 这是多行注释
 * 这是多行注释
 * 这是多行注释
 */
void reduce(){

}

三：文档注释

文档注释以 /// 或者 /** 开始，不过 /// 是 Dart 推荐使用的文档注释语法， 在连续行上使用 /// 与多行文档注释具有相同的效果。

/// [name] 姓名
/// [age] 年龄
/// [sex] 性别
class People {
  final String name;
  final int age;
  final int sex;

  /**
   * [name] 姓名
   * [age] 年龄
   * [sex] 性别
   * */
  People(this.name, this.age, this.sex);
}

文档注释可以是多行注释，也可以是单行注释。

在文档注释中，除非用中括号括起来，否则 Dart 编译器会忽略所有文本。 使用中括号可以引用类、 方法、 字段、 顶级变量、 函数和参数，括号中的符号会在已记录的程序元素的词法域中进行解析。

你的问题得到解决了吗？欢迎在评论区留言。

赠人玫瑰，手有余香，如果觉得文章不错，希望可以给个一键三连，感谢。

结束语 技术是一点一点积累的，大神也不是一天就可以达到的。原地不动就是退步，所以每天进步一点点。 最后，附上一句格言："好学若饥，谦卑若愚"，望共勉。