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 樣式的文檔注釋
/** ... */
,但這種類型的文檔注釋會產生兩個無實際內容的行,對於使用*
標志列表項等場景並不方便,所以推薦使用///
文檔注釋。