如何参考现有文档

Question

这是我想要完成的一个示例。

/// This is a doc string for this method. 
method1(){}

@method1DocString
////method 2 doc string added to method1's here.
method2(){}

所以method2的文档是：

这是此方法的文档字符串。
方法 2 文档字符串添加到方法 1 的此处。

我很确定我以前见过这样做。无需在适用的情况下重写文档。还可以更轻松地维护准确的文档。

在 dart 中正确的语法是什么？

Answer 1

这正是我想要的，感谢@pskink：

/// {@template method1_documentation}
/// This is a doc string for this method. 
/// {@endtemplate}
method1(){}

/// {@macro method1_documentation}
/// method 2 doc string added to method1's here.
method2(){}

在文档中：https://pub.dev/packages/dartdoc#macros