如何在pubspec.yaml的description字段中添加空行

问题核心原因 #

你用的>-/->.写法本身就不符合保留空行的YAML语法规则：

• >开头的是折叠块标量，默认会把单行换行转换为空格，仅连续多换行才会被压缩为单个换行，不同解析器对这类语法的空行处理逻辑差异极大
• ->.的块标量指示符顺序错误，YAML块标量的语法规则是样式符（|/>）在前，裁剪符（-/+）、缩进符在后，顺序错了会直接导致解析结果偏离预期
• YAML原生没有.代表空行的语法，你写的.会被识别为普通文本内容，自然无法触发空行效果

正确实现方式 #

直接使用字面块标量语法，就能100%保留你写的所有换行、空行，Redocly可以正常识别：

• 基础写法（保留内容末尾的自动换行）：

description: |
  第一行描述内容：这是你的Dart/Flutter包的基础介绍

  空一行后写第二部分内容：比如包的核心能力、适用场景

  再空一行写第三部分内容：比如使用注意事项、相关提示

• 裁剪末尾换行写法（如果需要避免description末尾多出空行）：

description: |-
  第一行包介绍文本

  空行后的详细功能说明

这种写法是YAML标准语法，所有符合规范的YAML解析器、包括Redocly都能正确识别其中的空行效果，不需要额外加特殊标记。

注意：所有块标量写法下，后续的描述内容必须比description字段多缩进至少2个空格，否则会出现YAML解析报错。

内容的提问来源于stack exchange，提问作者noonecious