Dart函数文档报错:需包含`params:`关键字,请求解释
关于Dart
talawa_good_doc_comments Lint错误的解释 这个错误是Talawa项目自定义的代码规范检查规则,要求函数/方法的文档注释必须明确使用params:关键字来专门列出并说明每个参数的作用,以此统一项目中文档格式,提升团队协作时的代码可读性。
你的当前注释只是提到参数来源于[model]和[context],但没有遵循规则要求的结构化格式:
/// Shows a list of dropdown taken from [model] and [context].
正确的注释格式示例
/// 展示下拉选择列表 /// /// params: /// - [model]: 提供下拉选项数据的模型 /// - [context]: 用于访问组件树的BuildContext对象 void dropwDownList(ModelType model, BuildContext context) { // 函数实现代码 }
核心要求拆解
- 必须单独用一行标注
params:,作为参数说明的起始标识 - 每个参数用
- [参数名]: 参数说明的格式单独列出,清晰对应每个参数的用途
内容的提问来源于stack exchange,提问作者Siddhesh B. Kukade
相关产品推荐
相关产品推荐

