flutter -//和///在flutter中有什么区别

Question

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

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

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

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

提前致谢

Answer 1

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

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

---

例子:

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

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

除此之外，请引用有关 dartdoc 的官方文档 guides-documenting-dart-libraries .有关用法和示例，请参阅 guides-dartdoc