dart - 如何记录 dart 函数/构造函数参数？

Question

使用 dart 可以通过注释作为类/函数定义的前缀，以便分析器将其解释为文档:

/// Some documentation for [Foo]
class Foo {

}

但是如何使用参数来实现相同的行为呢？

我尝试了以下方法:

void myFunction(
 /// Some parameter documentation
 String parameter,
) {

}

但这不起作用。

然而，这似乎是可能的，因为 dartanalyzer确实包含 ParameterElement 上的属性用于文档。

Answer 1

https://www.dartlang.org/guides/language/effective-dart/documentation

这是文档最佳实践的官方 Dart 语言指南。它涵盖了大多数/所有情况，并有很好的做和不做的例子。

This bit显示了包含参数的方法。基本上，将参数用方括号括起来，并用一个句子解释它。