Dart支持三种注释类型: 单行注释,多行注释,文档注释。
单行注释
单行注释以//开头,从//开始到一行结束的所有内容都会被Dart编译器忽略,示例代码如下:
main(){
//打印输出
print('Hi Dart');
}
多行注释
单行注释以 /* 开头, 以*/结束, 之间的所有内容都会被Dart编译器忽略掉,示例代码如下:
/**
*print('实例化一个动物类');
var animal = new Animal();
animal.eat();
animal.run();
print('实例话一个人类');
var human = new Human();
human.eat();
human.run();
human.say();
human.study();
*
*/
文档注释
文档注释以/** */或者 ///开头。/// 是 Dart 推荐使用的文档注释语法,dartdoc 会根据文档注释生成 HTML 文档,使用方括号可以链接到一个类、方法、字段等位置。
示例代码如下:
/// Feeds your llama [Food].
///
/// The typical llama eats one bale of hay per week.
void feed(Food food) {
// …
}
由于历史原因, Dart 也支持 JavaDoc 样式的文档注释 /** ... */
,但这种类型的文档注释会产生两个无实际内容的行,对于使用 *
标志列表项等场景并不方便,所以推荐使用 ///
文档注释。
手机扫一扫
移动阅读更方便
你可能感兴趣的文章