Question

我为我的Django项目使用Google Style Python Docstrings like in this Example。当我在docstring中创建一个类并使用属性表示法时，Pycharm总是说 - ＆＃34;未解析的引用＆＃34;。

class Post(models.Model):
    """
    Class for posts.

    Attributes:
        title(str): Post title.
    """
    title = models.CharField(max_length=120)

我理解PyCharm没有看到self title和def __init__()函数并编写此错误，但在Django中我从未见过使用{{1对于从def __init__()继承的类。

我该怎么办？这是我的错误还是PyCharm在这种情况下看不到上下文？我应该使用models或其他东西，还是以其他方式编写docsting？

Answer 1

PyCharm当前似乎不支持此功能。如果要避免在文档字符串中看到这些“无法解析的引用”错误，唯一的解决方法是在“首选项”>“编辑器”>“检查”>“未解析的引用”中禁用检查。

我过去尝试过的另一个选项是删除“ Attributes：”标头，并在与文档字符串其余部分相同的缩进级别上编写我的属性文档。这不再向您发出警告，但您不再100％遵守Google Docstring样式指南。

Answer 2

我通过在'Attributes：'之后添加'＃noqa'解决了此问题，因为我不想禁用未解决的参考警告。

这将是最终的文档字符串：

"""
Class for posts.

Attributes:  # noqa
    title(str): Post title.
"""

在PyCharm {Dj}中使用Django的文档字符串中未解决的引用

2 个答案: