メインコンテンツにスキップ

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) => '';

テキストを山括弧を含めてそのまま表示したい場合は、山括弧の前にバックスラッシュエスケープを追加してください。

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