跳到主内容

unintended_html_in_doc_comment

尖括号将被解释为 HTML。

描述

#

当文档注释包含不在允许例外列表中的尖括号括起来的文本(<...>)时,分析器会产生此诊断。

markdown 会将此类文本解释为 HTML 标签,这通常不是预期的结果。

请参阅Lint 规则描述以获取允许例外的列表。

示例

#

以下代码会产生此诊断,因为文档注释包含了文本 <int>,这不在允许例外列表之中。

dart
/// Converts a List<int> to a comma-separated String.
String f(List<int> l) => '';

常见修复

#

如果文本是代码片段的一部分,请在代码周围添加反引号。

dart
/// Converts a `List<int>` to a comma-separated String.
String f(List<int> l) => '';

如果文本是链接的一部分,请在代码周围添加方括号。

dart
/// Converts a [List<int>] to a comma-separated String.
String f(List<int> l) => '';

如果 intended 文本需要按原样打印(包括尖括号),请在尖括号前添加反斜杠转义符。

dart
/// Converts a List\<int\> to a comma-separated String.
String f(List<int> l) => '';