Windows 下使用 VSCode 编辑 *.rst 文件的错误提示

Kaffa 发布于

分类: 数智 标签: VSCode reStructuredText

问题出现的场景

  1. 使用 VSCode 编辑 *.rst 文件时，会提示安装 doc8 ，于是使用 pip 安装 doc8，执行:

    pip install doc8

  2. 重新打开文件，全文会出现两条警告 D002 和 D004，如下:

    'D002 Trailing whitespace'
'D004 Found literal carriage return'

D002 信息按字面意思是行尾有空格，稍作思考，感觉可能和 Windows 的换行符 CRLF 有关， 于是点击 VSCode 状态栏，修改 CRLF 为 LF，之后错误提示消失。请参考：issues-84

  1. 又产生新的警告 D001，如下:

    'D001 Line Too Long'

在 issues-83 中给的解决方法是，在 VSCode 的用户配置中提供一个更大的行宽度值。 于是 Ctrl + P，选择 Preferences: Open Settings，在 User Settings 标签页， 也就是 C:\Users\username\AppData\Roaming\Code\User\settings.json 文件加入如下配置:

"restructuredtext.linter.extraArgs": [
    "--max-line-length 80"
]

我的理解是，这个最大行宽在 *.rst 文件中不建议设置太大，大约每行最多 80 个字符就差不多了， 这个和可维护性代码的最佳实践是一致的。

感谢阅读。