flutter Dart:在函数/方法文档中包含'params:'关键字

gab6jxml  于 2023-03-13  发布在  Flutter
关注(0)|答案(1)|浏览(141)

我正在尝试为这个函数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. Includeparams:keyword in function/method docdart(talawa_good_doc_comments)
以下是

的屏幕截图
我不明白他们在评论中添加params:是什么意思,请解释。

g9icjywg

g9icjywg1#

此lint错误是由Talawa项目内的自定义lint扩展引入的。它强制您遵守文档的特定格式。在您的示例中,您没有使用params:关键字描述函数的所有参数。通过此lint检查的文档示例如下所示

/// This function is used to do something special.
///
/// params:
/// * `input`: The input.
/// returns:
/// * `string`: An output.
string doSomething(string input) {}

您可以找到此规则的实现here on github

相关问题