首页 > 解决方案 > 如何记录飞镖函数/构造函数参数?

问题描述

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

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

}

但是我怎样才能实现相同的行为,而不是使用参数呢?

我尝试了以下方法:

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

}

但这不起作用。


但是,这似乎是可能的,因为dartanalyzer 确实包含ParameterElement文档属性。

标签: dart

解决方案


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

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

该位显示包含参数的方式。基本上,将参数括在方括号中并在解释它的句子中。


推荐阅读