flutter 中 // 和 /// 有什么区别答案

【问题标题】：What is the diffrence between // and /// in flutterflutter 中 // 和 /// 有什么区别
【发布时间】：2023-01-26 15:35:44
【问题描述】：

我只是在评论我的应用程序，因为我发现您可以使用不同的评论。我很好奇是否有一些评论规则，或者它是否与 flutter it self 的自动评论有关？

我选择了 /// 一个，因为颜色不同，所以最好看看我评论了什么以及 flutter 做了什么。

这让我想知道为什么有两种不同的评论方式

//  <-- This is a way
/// <-- This is a way

提前致谢

【问题讨论】：

// -> Indicates Single Line Comment & /// -> Documentation comment. To learn more: dart.dev/guides/language/effective-dart/documentation

【解决方案1】：

在 Flutter 中，// 用于创建单行注释，它会被 Dart 编译器忽略。

/// 用于创建文档注释，可用于使用dartdoc 工具为您的代码生成文档。这种类型的注释也会被 Dart 编译器忽略，但它可以用来为阅读代码的开发人员提供有关类、函数或变量的附加信息。

例子：

/// This is a documentation comment for a function
void myFunction() {
  // this is a single-line comment
}

当您使用dartdoc 工具时，它会从代码中提取 cmet 并生成 HTML 格式的文档。

除此之外，请参考关于dartdocguides_documenting-dart-libraries的官方文档 .有关用法和示例，请参考guides_dartdoc

【讨论】：

【解决方案2】：

根据Effective Dart，

// 用于单行注释，就像您在函数内部一样

/// 用于多行（尽管也支持单行）文档 cmets，就像您在函数定义上方一样。

【讨论】：