Dart枚举文档注释中方括号[]无法显示的解决方法求助
解决Dart文档注释中方括号[]不显示的问题
Dart的文档生成工具(dartdoc)会将方括号[]解析为链接或引用的语法标记,直接书写会被过滤掉,导致显示缺失。可以用两种方法解决:
- 转义方括号:在方括号前加反斜杠
\,让工具将其视为普通字符 - 用反引号包裹:把方括号当成代码片段包裹起来,既保留显示,还能和普通文本区分
修改后的代码示例:
/// Define the brackets used when displaying a `List` in a cell. /// /// Supported bracket types are: /// * parentheses: () /// * curly: {} /// * square: \[] // 转义写法 /// 或者用代码片段写法: /// * square: `[]` enum ListBrackets { /// Use parentheses parentheses, /// Use curly brackets curly, /// Use square brackets square; }
两种写法都能让生成的文档正常显示square: []的内容。
内容的提问来源于stack exchange,提问作者jksevend
相关产品推荐
相关产品推荐

