點燈坊

失くすものさえない今が強くなるチャンスよ

Dart 之 Comment

Sam Xiao's Avatar 2024-03-15

Dart 提供三種 Comment:Single-line Comment、Multi-line Comment 與 Documentation Comment。

Version

Dart 3.3

Single-line Comment

void main() {
  // var name = 'Sam';
  print('Hello $name');
}
  • // 為單行註解

Multi-line Comment

void main() {
  /*
  var name = 'Sam';
  print('Hello $name');
   */
}
  • /**/ 之間為多行註解

Documentation Comment

/// [main] is the first function to execute on Dart
void main() {
  var name = 'Sam';

  print('Hello $name');
}
  • Dart 另外提供 /// 為 function 或 class 提供註解
  • 可在 [] 內提供 class、function、variable、parameter… 自動跳轉
  • Dart 另外提供 dart doc 可將 /// 的註解轉成 HTML 文件

Conclusion

  • Android Studio 按 ⌘ + / 下 comment,都以 single-line comment 形式呈現
  • JavaScript 只提供 //*,Dart 則多提供了 ///

Reference

Dart, Comments
Dart, dart doc