我应该使用 // 还是 /// 在 Dart 中进行评论？ 它会使应用程序变慢吗？

Question

当我检查包中的代码时，我看到它们同时使用//和///进行注释。

// 是一个普通的注释。

///是突出显示的注释。

似乎使用 /// 更好，那么为什么他们同时使用它们呢？ 在 Dart 中使用注释时，它是否会使应用程序变慢？

Answer 1

务必使用 /// doc 注释来记录成员和类型。

使用 doc 注释而不是常规注释使dartdoc能够找到它并为其生成文档。

例子：

    /// The number of characters in this chunk when unsplit.
int get length => ...

请参阅此处的官方指南。

---

由于历史原因，dartdoc 支持两种文档注释语法： /// （“C# 风格”）和/** ... */ （“JavaDoc 风格”）。 我们更喜欢///因为它更紧凑。 /** and */向多行文档注释添加两个无内容行。 ///语法在某些情况下也更容易阅读，例如当文档注释包含使用 * 标记列表项的项目符号列表时。

如果您偶然发现仍然使用 JavaDoc 样式的代码，请考虑清理它。

---

在 Dart 中使用注释时会不会使应用程序变慢？

不，dart 编译器会将它们从发布版本中删除。

Answer 2

首先它不会影响你的代码速度，编译器只是忽略它，它是给你和其他开发人员的。

其次， //它只是对您现在不使用的普通文本或代码的普通注释。 但是///它用于记录您的代码并解释您的函数或代码应该做什么。

您可以从http://dartdoc.takyam.com/articles/doc-comment-guidelines/阅读完整的 DartDoc