飞镖评论中的转义字符

Question

我想在评论中描述一个半开期[start, end)，其中start 和end 都指的是方法的参数：

/// Gets all items within period [[start],[end])

intelij 是这样显示的：

使用\ 作为转义字符有同样的问题：

dart cmets 中的转义字符是什么？ official documentation 似乎没有说明如何逃避[。

Answer 1

我不知道你说的转义字符，但是你可以在你想显示的单个括号之后添加一对额外的括号：

/// Gets all items within period [[][start],[end])

看起来像这样：

当您将鼠标悬停在方法上时：

Answer 2

通常方括号表示 dartdoc 应该自动为其生成链接的标识符。如果你想在生成的文档中使用方括号，你可以用反斜杠转义它们：

/// Gets all items within period \[[start],[end])

例如the following comment:

/// A fraction in the range \[0, 1\] that represents what proportion of the
/// widget is visible (assuming rectangular bounding boxes).

产生： https://pub.dev/documentation/visibility_detector/latest/visibility_detector/VisibilityInfo/visibleFraction.html

Answer 3

我还需要将括号作为范围的一部分进行注释。

我最终用 3 个反引号 (```) 转义了整行

缺点是我无法在该（代码）注释中引用任何参数/方法，但从好的方面来说，该注释在代码中仍然非常可读。

如果您需要引用参数，可能会添加额外的行来执行此操作

例如：

/// ```
/// Gets all items within period [start,end]
/// ```
///
/// The referred values are [start], [end]