Question

使用dart可以在类/函数定义的前面加上注释，以便分析器将其解释为文档：

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

}

但是如何通过参数代替来实现相同的行为？

我尝试了以下操作：

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

}

但这不起作用。

但是，似乎有可能是因为dartanalyzer do 在ParameterElement上包含用于文档的属性。

Answer 1

以下是有关文档最佳做法的官方Dart语言指南。它涵盖了大多数情况/所有情况，并提供了可以做和不可以做的很好的例子。

This bit显示了包含参数的方式。基本上，将参数包装在方括号中并在解释它的句子中。