dart - 如何记录飞镖函数/构造函数参数?
问题描述
使用 dart 可以通过注释为类/函数定义添加前缀,以便分析器将其解释为文档:
/// Some documentation for [Foo]
class Foo {
}
但是我怎样才能实现相同的行为,而不是使用参数呢?
我尝试了以下方法:
void myFunction(
/// Some parameter documentation
String parameter,
) {
}
但这不起作用。
但是,这似乎是可能的,因为dartanalyzer
确实包含ParameterElement
文档属性。
解决方案
https://www.dartlang.org/guides/language/effective-dart/documentation
这是文档最佳实践的官方 Dart 语言指南。它涵盖了大多数/所有情况,并有很好的做和不做的例子。
该位显示包含参数的方式。基本上,将参数括在方括号中并在解释它的句子中。
推荐阅读
- c - c中结构数组的大小是否有限制
- python - Python Selenium - 通过滚动缩小?
- hyperledger-fabric - 运行订单和对等时出现 Hyper ledger 多主机设置错误
- java - 使用 Intent.ACTION_GET_CONTENT 时如何不显示空的 0 B 文件?
- arrays - 如何迭代两个字节切片
- java - 如何将for循环的结果存储为java中的数组?还有其他方法可以让我以简洁的方式编写此代码吗?
- python - Python plotly sunburst图打开空白页面
- python - 如何让 OOP 代码打印我的类对象名称?
- css - 我可以使属性仅适用于选定的子元素吗?
- c# - 有没有办法将工具提示放在特定文本上?