如何在 Dart 和 Flutter 中创建 DartDoc Macros/Templates?

How do I create DartDoc Macros/Templates in Dart and Flutter?

我在整个 Flutter 代码库中看到了如下片段:

/// {@macro flutter.widgets.editableText.readOnly}

在 IDE 和呈现的 Dart 文档中,它是 shown like this:

Whether the text can be changed.

When this is set to true, the text cannot be modified by any shortcut or keyboard operation. The text is still selectable.

Defaults to false. Must not be null.

而且它往往会超出这个基本情况。

您可以创建模板并将它们用作使用dartdoc ,这是 Flutter 默认自带的 API 文档包。

只需在文档中的任意位置定义 @template

/// {@template template_name}
/// Some shared docs
/// {@endtemplate}

现在,您可以在其他任何地方重复使用它:

/// Some comment
/// {@macro template_name}
/// More comments

Learn more.