flutter - 如何在 Dart 和 Flutter 中创建 DartDoc 宏/模板？

Question

我在 Flutter 存储库中看到了如下片段：

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

在 IDE 和渲染的 Dart 文档中，它显示如下：

是否可以更改文本。

当此设置为 true 时，文本不能通过任何快捷方式或键盘操作进行修改。文本仍然是可选的。

默认为假。不得为空。

它往往超出这个基本情况。

Answer 1

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

只需@template在您的文档中定义一个位置：

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

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

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

了解更多。