回答问题

我在我的 Django 项目中使用 Google Style Python Docstrings就像在这个示例中一样。当我创建一个类并在文档字符串中使用属性表示法时,Pycharm 总是说 - “未解析的引用”。

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

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

我知道 PyCharm 没有看到title和def __init__()函数的self并写了这个错误,但是在 Django 中,我从未见过使用def __init__()来处理从models继承的类。

我应该怎么办?这是我的错误还是 PyCharm 在这种情况下看不到上下文?我应该使用def __init__()或其他东西还是以其他方式编写文档?

Answers

PyCharm 目前似乎不支持此功能。 JetBrains 问题跟踪器中针对此问题的活跃问题是https://youtrack.jetbrains.com/issue/PY-16760,请考虑对其进行投票以修复它。如果您想避免在文档字符串中看到这些“未解决的引用”错误,唯一的解决方法是禁用 Preferences > Editor > Inspections > Unresolved references 中的检查。

我过去尝试过的另一个选项是删除“属性:”标题并将我的属性文档写在与文档字符串的其余部分相同的缩进级别上。这不再给您一个警告,但您不再 100% 遵守 Google Docstring Style Guide。