如何在PyCharm中自动格式化文档字符串？

安全阿岳

2026-7-19

文档字符串自动换行调整工具推荐

VS Code：内置的「格式化文档」功能（快捷键Ctrl+Shift+I）配合Python插件就能处理docstring的自动换行。你可以在设置里搜索python.formatting.provider选择autopep8或black，这些工具会自动根据你设定的行宽（比如默认79字符）调整段落，智能拆分单词到下一行，不会截断单词。另外也可以安装Docstring Formatter插件，专门针对docstring做格式化，支持多种风格（Google、NumPy等），能自动调整行长度。
PyCharm/IntelliJ：自带的代码格式化功能（快捷键Ctrl+Alt+L）可以配置docstring的行宽限制。在设置里找到「Editor > Code Style > Python > Docstrings」，设定合适的右侧边距，格式化时就会自动调整段落，保持单词完整的前提下换行。
Vim/Neovim：可以用vim-autoformat插件，配合autopep8或black作为格式化工具，配置后执行:Autoformat就能自动调整docstring行长度。另外gq命令（默认的文本格式化）也能基于设定的textwidth参数来换行，不过需要确保开启了formatoptions里的w选项（自动在单词边界换行）。
通用命令行工具：直接用autopep8或black，它们会自动处理整个项目里的Python文件，包括docstring的换行调整。比如执行black your_file.py就能按默认行宽（88字符）格式化所有内容，包括docstring段落。