我正在尝试为这个函数dropwDownList
编写文档。
/// Shows a list of dropdown taken from [model] and [context].
Widget dropDownList(ExploreEventsViewModel model, BuildContext context) {
return DropdownButton<String>(
key: homeModel?.keySECategoryMenu,
value: model.chosenValue,
isExpanded: true,
.....
}
在写上面的文档行时,我得到了这个lint错误。Wrong doc format. Include
params:keyword in function/method docdart(talawa_good_doc_comments)
以下是
的屏幕截图
我不明白他们在评论中添加params:
是什么意思,请解释。
1条答案
按热度按时间g9icjywg1#
此lint错误是由
Talawa
项目内的自定义lint扩展引入的。它强制您遵守文档的特定格式。在您的示例中,您没有使用params:
关键字描述函数的所有参数。通过此lint检查的文档示例如下所示您可以找到此规则的实现here on github。