python - 是否可以向 PyCharm 中的所有函数批量添加文档字符串？

Question

我有一个 python 项目，其中许多函数和类都缺少文档字符串。我知道 PyCharm 可以使用意图操作通过 Insert documentation string stub 命令自动添加文档字符串。但是，对于大量的方法和函数，这是繁琐的。有没有一种方法可以一次性向所有函数批量添加文档字符串？然后我将手动填写必要的内容。

如果不是在 PyCharm 中，是否有任何替代客户端可以做到这一点？

在此先感谢您的帮助...

Answer 1

最后，我找到了答案，或者可能是一种解决方法

在 pyCharm 中，

1. 转到 File\Settings\Code Style\Inspections，然后在“Missing or empty docstring”前面打勾，然后按 OK 按钮。
2. 转到代码\检查代码\然后选择自定义范围>>打开文件
3. 您会在下面找到一个面板，其中包含您的项目名称，然后是 Python\Missing 或空文档字符串\
4. 右键单击标题“Missing or empty docstring”，然后选择命令 {Apply fix 'Fix docstring'}
5. 程序会自动将文档添加到所有函数和类。

这对我有用，如果有人有更好的解决方案或解决方法，请与我们分享。