Effective Dart：文档

内容 keyboard_arrow_down keyboard_arrow_up

注释
- 将格式注释像句子一样编写
- 不要使用块注释进行文档编写
文档注释
Markdown
写作

more_horiz

很容易认为你的代码今天很明显，却没有意识到你有多依赖于你脑子里已经存在的上下文。你的代码新手，甚至是你健忘的未来自我，都不会有那个上下文。一个简洁、准确的注释只需要几秒钟就能写出来，但可以为其中一个人节省几个小时的时间。

我们都知道代码应该是自文档化的，并不是所有的注释都有用。但现实是，我们大多数人写的注释没有我们应该写的那么多。这就像锻炼：你从技术上讲可以做得太多，但你更有可能做得太少。试着加强一下。

以下提示适用于你不希望包含在生成的文档中的注释。

良好dart// Not if anything comes before it.
if (_chunks.isNotEmpty) return false;

将第一个单词大写，除非它是一个区分大小写的标识符。以句号结尾（或者“！”或“？”，我想）。这适用于所有注释：文档注释、内联内容，甚至 TODO。即使它是一个句子片段。

良好dartvoid greet(String name) {
  // Assume we have a valid name.
  print('Hi, $name!');
}

不良dartvoid greet(String name) {
  /* Assume we have a valid name. */
  print('Hi, $name!');
}

你可以使用块注释（/* ... */）临时注释掉一段代码，但所有其他注释都应该使用//。

文档注释特别方便，因为dart doc会解析它们并从它们生成漂亮的文档页面。文档注释是出现在声明之前并使用特殊///语法的任何注释，dart doc会查找这种语法。

代码风格检查规则：slash_for_doc_comments

使用文档注释而不是普通注释，使dart doc能够找到它并为其生成文档。

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

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

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

如果你偶然发现了仍然使用 JavaDoc 风格的代码，可以考虑清理它。

代码风格检查规则：package_api_docs，public_member_api_docs

你不必记录每个库、顶级变量、类型和成员，但你应该记录其中大部分。

与 Java 等语言不同，在 Java 中，类是程序组织的唯一单元，在 Dart 中，库本身就是一个用户直接使用、导入和思考的实体。这使得library指令成为介绍读者库中提供的核心概念和功能的绝佳位置。考虑包含

库用途的单句摘要。
对整个库中使用的术语的解释。
几个完整的代码示例，逐步演示如何使用 API。
指向最重要或最常用类和函数的链接。
指向库关注的领域的外部参考的链接。

要记录库，请在library指令和可能附加在文件开头的任何注释之前放置文档注释。

良好dart/// A really great test library.
@TestOn('browser')
library;

文档注释不仅仅面向库公共 API 的外部使用者。它们还可以帮助理解从库的其他部分调用的私有成员。

以简短的用户为中心的描述开头你的文档注释，并以句号结尾。一个句子片段通常就足够了。为读者提供足够的上下文，以便他们能够确定方向并决定是否应该继续阅读或在其他地方寻找他们问题的解决方案。

良好dart/// Deletes the file at [path] from the file system.
void delete(String path) {
  ...
}

不良dart/// Depending on the state of the file system and the user's permissions,
/// certain operations may or may not be possible. If there is no file at
/// [path] or it can't be accessed, this function throws either [IOError]
/// or [PermissionError], respectively. Otherwise, this deletes the file.
void delete(String path) {
  ...
}

在第一句之后添加一个空行，将其分成单独的一段。如果超过一个解释句是有用的，请将其余部分放在后面的段落中。

这有助于你编写一个简洁的第一句话，总结文档。此外，像dart doc这样的工具会在类和成员列表等地方使用第一段作为简短摘要。

良好dart/// Deletes the file at [path].
///
/// Throws an [IOError] if the file could not be found. Throws a
/// [PermissionError] if the file is present but could not be deleted.
void delete(String path) {
  ...
}

不良dart/// Deletes the file at [path]. Throws an [IOError] if the file could not
/// be found. Throws a [PermissionError] if the file is present but could
/// not be deleted.
void delete(String path) {
  ...
}

类文档注释的读者可以清楚地看到类的名称、它实现了哪些接口等。在阅读成员文档时，签名就在那里，并且封闭类是显而易见的。文档注释中不需要详细说明这些内容。相反，重点解释读者不知道的内容。

良好dartclass RadioButtonWidget extends Widget {
  /// Sets the tooltip to [lines], which should have been word wrapped using
  /// the current font.
  void tooltip(List<String> lines) {
    ...
  }
}

不良dartclass RadioButtonWidget extends Widget {
  /// Sets the tooltip for this radio button widget to the list of strings in
  /// [lines].
  void tooltip(List<String> lines) {
    ...
  }
}

如果你真的没有什么有趣的话要说，而这些话不能从声明本身推断出来，那么就省略文档注释。与其浪费读者的时间告诉他们他们已经知道的事情，不如什么也不说。

文档注释应该关注代码做什么。

良好dart/// Returns `true` if every element satisfies the [predicate].
bool all(bool predicate(T element)) => ...

/// Starts the stopwatch if not already running.
void start() {
  ...
}

文档注释应该强调属性的**是什么**。即使对于可能进行计算或其他操作的 getter 也是如此。调用者关心的是该操作的**结果**，而不是操作本身。

良好dart/// The current day of the week, where `0` is Sunday.
int weekday;

/// The number of checked buttons on the page.
int get checkedCount => ...

文档注释应该阐明此变量表示的状态。即使对于可能进行计算或其他操作的 getter 也是如此。调用者关心的是该操作的**结果**，而不是操作本身。

良好dart/// Whether the modal is currently displayed to the user.
bool isVisible;

/// Whether the modal should confirm the user's intent on navigation.
bool get shouldConfirm => ...

/// Whether resizing the current browser window will also resize the modal.
bool get canResize => ...

如果一个属性同时具有 getter 和 setter，则只为其中一个创建文档注释。dart doc 将 getter 和 setter 视为单个字段，如果 getter 和 setter 都有文档注释，则 dart doc 会丢弃 setter 的文档注释。

良好dart/// The pH level of the water in the pool.
///
/// Ranges from 0-14, representing acidic to basic, with 7 being neutral.
int get phLevel => ...
set phLevel(int level) => ...

不良dart/// The depth of the water in the pool, in meters.
int get waterDepth => ...

/// Updates the water depth to a total of [meters] in height.
set waterDepth(int meters) => ...

类的文档注释通常是程序中最重要的文档。它们描述了类型的**不变式**，建立了它使用的术语，并为类的成员的其他文档注释提供了上下文。在这里多花一点精力可以使所有其他成员更容易记录。

良好dart/// A chunk of non-breaking output text terminated by a hard or soft newline.
///
/// ...
class Chunk { ... }

良好dart/// Returns the lesser of two numbers.
///
/// ```dart
/// min(5, 3) == 3
/// ```
num min(num a, num b) => ...

人类非常擅长从示例中概括，因此即使是一个代码示例也能使 API 更易于学习。

代码检查规则：comment_references

如果将变量、方法或类型名称等用方括号括起来，则 dart doc 会查找名称并链接到相关的 API 文档。括号是可选的，但当您引用方法或构造函数时，可以使它更清晰。

良好dart/// Throws a [StateError] if ...
/// similar to [anotherMethod()], but ...

要链接到特定类的成员，请使用类名和成员名，并用点分隔。

良好dart

/// Similar to [Duration.inDays], but handles fractional days.

点语法也可用于引用命名构造函数。对于未命名构造函数，请在类名后使用.new

良好dart

/// To create a point, call [Point.new] or use [Point.polar] to ...

其他语言使用冗长的标签和部分来描述方法的参数和返回值是什么。

不良dart/// Defines a flag with the given name and abbreviation.
///
/// @param name The name of the flag.
/// @param abbr The abbreviation for the flag.
/// @returns The new flag.
/// @throws ArgumentError If there is already an option with
///     the given name or abbreviation.
Flag addFlag(String name, String abbr) => ...

Dart 中的约定是将这些内容整合到方法的描述中，并使用方括号突出显示参数。

良好dart/// Defines a flag.
///
/// Throws an [ArgumentError] if there is already an option named [name] or
/// there is already an option using abbreviation [abbr]. Returns the new flag.
Flag addFlag(String name, String abbr) => ...

良好dart/// A button that can be flipped on and off.
@Component(selector: 'toggle')
class ToggleComponent {}

不良dart@Component(selector: 'toggle')
/// A button that can be flipped on and off.
class ToggleComponent {}

您可以在文档注释中使用大多数markdown 格式，并且dart doc 会使用markdown 包相应地处理它。

已经有大量指南可以向您介绍 Markdown。它的普遍流行是我们选择它的原因。这里只是一个快速示例，让您了解支持的功能

dart/// This is a paragraph of regular text.
///
/// This sentence has *two* _emphasized_ words (italics) and **two**
/// __strong__ ones (bold).
///
/// A blank line creates a separate paragraph. It has some `inline code`
/// delimited using backticks.
///
/// * Unordered lists.
/// * Look like ASCII bullet lists.
/// * You can also use `-` or `+`.
///
/// 1. Numbered lists.
/// 2. Are, well, numbered.
/// 1. But the values don't matter.
///
///     * You can nest lists too.
///     * They must be indented at least 4 spaces.
///     * (Well, 5 including the space after `///`.)
///
/// Code blocks are fenced in triple backticks:
///
/// ```dart
/// this.code
///     .will
///     .retain(its, formatting);
/// ```
///
/// The code language (for syntax highlighting) defaults to Dart. You can
/// specify it by putting the name of the language after the opening backticks:
///
/// ```html
/// <h1>HTML is magical!</h1>
/// ```
///
/// Links can be:
///
/// * https://www.just-a-bare-url.com
/// * [with the URL inline](https://google.com)
/// * [or separated out][ref link]
///
/// [ref link]: https://google.com
///
/// # A Header
///
/// ## A subheader
///
/// ### A subsubheader
///
/// #### If you need this many levels of headers, you're doing it wrong

如有疑问，请减少格式化。格式化的目的是阐明您的内容，而不是替换它。文字才是重要的。

在某些罕见情况下（例如表格），使用它可能**有用**，但在几乎所有情况下，如果用 Markdown 表达过于复杂，最好不要表达。

Markdown 有两种方法可以指示代码块：在每一行的代码前缩进四个空格，或将其括在一对三反引号“围栏”行中。当在 Markdown 列表等内容内部使用时，前一种语法很脆弱，因为缩进在这些内容中已经具有意义，或者当代码块本身包含缩进代码时。

反引号语法避免了这些缩进问题，允许您指示代码的语言，并且与使用反引号进行内联代码一致。

良好dart/// You can use [CodeBlockExample] like this:
///
/// ```dart
/// var example = CodeBlockExample();
/// print(example.isItGreat); // "Yes."
/// ```

不良dart/// You can use [CodeBlockExample] like this:
///
///     var example = CodeBlockExample();
///     print(example.isItGreat); // "Yes."

我们认为自己是程序员，但源文件中大部分字符的主要目的是供人类阅读。英语是我们用来修改同事大脑的编程语言。对于任何编程语言，都值得努力提高您的熟练程度。

本节列出了我们文档的一些指南。您可以在一般情况下从诸如技术写作风格等文章中了解更多关于技术写作最佳实践的信息。

清晰准确，但也要简洁。

许多人不知道“即”、“例如”和“等”是什么意思。您确定您所在领域每个人都知道的缩略词可能不像您想象的那样广为人知。

在为类记录成员时，您通常需要参考正在调用成员的对象。使用“该”可能会产生歧义。

dartclass Box {
  /// The value this wraps.
  Object? _value;

  /// True if this box contains a value.
  bool get hasValue => _value != null;
}

除非另有说明，否则本网站上的文档反映了 Dart 3.5.3。页面上次更新于 2024-05-06。查看源代码或报告问题。

Effective Dart：文档

注释

将格式注释像句子一样编写

不要使用块注释进行文档编写

文档注释

使用 `///` 文档注释来记录成员和类型

优先为公共 API 编写文档注释

考虑编写库级文档注释

考虑为私有 API 编写文档注释

文档注释应以一个单句摘要开头

将文档注释的第一句分成单独的一段

避免与周围上下文出现冗余

优先以第三人称动词开头函数或方法注释

优先以名词短语开头非布尔变量或属性注释

优先以“Whether”后跟名词或动名词短语开头布尔变量或属性注释

不要同时为属性的 getter 和 setter 编写文档

优先以名词短语开头库或类型注释

考虑在文档注释中包含代码示例

在文档注释中使用方括号来引用作用域内的标识符

使用散文来解释参数、返回值和异常

将文档注释放在元数据注释之前

Markdown

避免过度使用 Markdown

避免使用 HTML 进行格式化

优先使用反引号围栏创建代码块

写作

优先简洁

除非缩写和首字母缩略词很明显，否则避免使用它们

优先使用“this”而不是“the”来指代成员的实例

Effective Dart：文档

注释

将格式注释像句子一样编写

不要使用块注释进行文档编写

文档注释

使用 /// 文档注释来记录成员和类型

优先为公共 API 编写文档注释

考虑编写库级文档注释

考虑为私有 API 编写文档注释

文档注释应以一个单句摘要开头

将文档注释的第一句分成单独的一段

避免与周围上下文出现冗余

优先以第三人称动词开头函数或方法注释

优先以名词短语开头非布尔变量或属性注释

优先以“Whether”后跟名词或动名词短语开头布尔变量或属性注释

不要同时为属性的 getter 和 setter 编写文档

优先以名词短语开头库或类型注释

考虑在文档注释中包含代码示例

在文档注释中使用方括号来引用作用域内的标识符

使用散文来解释参数、返回值和异常

将文档注释放在元数据注释之前

Markdown

避免过度使用 Markdown

避免使用 HTML 进行格式化

优先使用反引号围栏创建代码块

写作

优先简洁

除非缩写和首字母缩略词很明显，否则避免使用它们

优先使用“this”而不是“the”来指代成员的实例

使用 `///` 文档注释来记录成员和类型