Pycharm 不会自动创建文档存根答案

【问题标题】：Pycharm does not auto-create documentation stubsPycharm 不会自动创建文档存根
【发布时间】：2016-03-29 19:05:37
【问题描述】：

我不确定为什么这台电脑会发生这种情况；它从未发生在任何其他人身上。当我尝试在 pycharm 中为函数或类创建文档字符串时，没有任何反应。即：

def foo(bar):
    """"""
    pass

应该在按下回车时插入一个文档字符串；相反，它只是这样做：

def foo(bar):
    """
    """
    pass

【问题讨论】：

A) 没有足够的信息。 B) 您应该将此作为错误报告提交给 IDE。
什么样的信息会有帮助？由于我认为他们需要多长时间才能回复，我不想费心将此作为错误提交。这是一台 Mac 机器，在最新的操作系统上，使用 Anaconda，完全更新。这是一个全新的 pycharm 安装，这是一个全新的项目。
您应该将所有这些信息放在问题中，而不是 cmets。标签下的编辑按钮仅用于此类事情。对于这样的事情，在冗长的一面是错误的。既然你不知道是什么导致了问题，那就给我们一切。在有人解决问题之前，您永远不会知道什么是相关的。提交错误报告时使用相同的理念。
另外，如果您认为某事是合法的错误只是因为您认为会有一些延迟（很可能不会），那么不提交错误报告是不负责任的。
我根据我的预期校准了信息量，这是“哦，是的，这发生在我身上，转到设置 > 常规 > ...”，因为我的先验建议如果这是一个错误，并且评论根本不适用于Mac，我会在stackoverflow和其他地方搜索时找到它。我有理由确定这个问题是由于我犯了一个愚蠢的错误。

标签： python pycharm

【解决方案1】：

我在 pyCharm 2019.3.1 上遇到了同样的问题，我只是按照pyCharm site's documentation 上的说明解决了这个问题

特别是在“文档字符串格式”部分，如下：

以防万一对 2020 年的任何人都有帮助 :)

【讨论】：

这可能是一个非常烦人的错误。此功能可以停止工作。现在我有两个项目打开。以前都按预期工作。但是突然之间它停止了工作。这种情况发生得太频繁了，所以我必须去找文档来提醒自己这个修复。

【解决方案2】：

确保在File -> Settings -> Tools -> Python Integrated Tools中选择了文档字符串格式

【讨论】：

这对我来说是个问题
PyCharm -> 首选项 -> Python 集成工具文档字符串

【解决方案3】：

为了解决这个问题，我不得不进入Settings -> Tools -> Python Integrated Tools 并重置文档字符串格式。为此，我将Docstring format 从Epytext 更改为Plain，单击Apply，然后再次将其更改回Epytext 并应用更改，现在一切正常。

PyCharm 版本：2021.1.2（社区版）

【讨论】：

对我不起作用！尝试了所有选项，但是 - 唉！..
@Stanislav Koncebovski 我又试了一次，它在 2021.2.3 对我有用。您使用的是哪个操作系统和 PyCharm 版本？给我们更多信息，很多人会发现它很有用。
感谢您的提及。这是我的一个愚蠢的错误。在 PyCharm 中，不是真正的解释器路径，而是一些不同的东西，它不知道自动文档字符串。

【解决方案4】：

这是一个known bug，应该在 2016.1.1 中修复。

一种解决方法，如问题中所述：

解决方法是在第一行代码之前只添加“””，然后填充时将该代码放在换行符下。笨重，但这是一种解决方法暂时。

【讨论】：

是的，这行得通。但是我有2021.3还是有问题！

【解决方案5】：

我设法通过将 MacOSX 上的键盘偏好设置从美国国际 - PC 更改为英国来解决此问题。 U.S. International - PC 中的双引号会触发系统等待字母重音，例如 " 然后 e 变为 ë。但是，它在所有编辑器中的行为似乎并不相同。

只是猜测，但 PyCharm 的背景中可能存在一些格式化魔法，由于使用美国国际 - PC 时添加了一些额外的（也看不见的）格式，导致 PyCharm 无法正常工作，这会阻止 PyCharm 添加所需的上下文知道它应该在按回车后创建文档字符串吗？

【讨论】：