我怎样才能告诉PyCharm参数期望是什么类型？

Question

当涉及到构造函数，赋值和方法调用时，PyCharm
IDE非常擅长分析我的源代码并弄清楚每个变量应该是什么类型。我很喜欢它，因为它给了我很好的代码补全和参数信息，并且如果我尝试访问一个不存在的属性，它会给我警告。

但是当涉及到参数时，它一无所知。代码完成下拉列表无法显示任何内容，因为它们不知道参数的类型。代码分析无法查找警告。

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

peasant = Person("Dennis", 37)
# PyCharm knows that the "peasant" variable is of type Person
peasant.dig_filth()   # shows warning -- Person doesn't have a dig_filth method

class King:
    def repress(self, peasant):
        # PyCharm has no idea what type the "peasant" parameter should be
        peasant.knock_over()   # no warning even though knock_over doesn't exist

King().repress(peasant)
# Even if I call the method once with a Person instance, PyCharm doesn't
# consider that to mean that the "peasant" parameter should always be a Person

这在一定程度上是有意义的。其他呼叫站点可以为该参数传递任何内容。但是，如果我的方法期望某个参数的类型为，则pygame.Surface我希望能够以某种方式向PyCharm指出，因此它可以Surface在其代码完成下拉列表中向我显示所有的属性，并在出现以下情况时突出显示警告我调用了错误的方法，依此类推。

有没有办法给PyCharm一个提示，然后说“
psst，该参数应该是X类型”？（或者，也许是本着动态语言的精神，“这个参数应该像X一样嘎嘎叫”？对此我可以接受。）

编辑： 下面的CrazyCoder的答案就可以了。对于像我这样想要快速摘要的任何新手，这里是：

class King:
    def repress(self, peasant):
        """
        Exploit the workers by hanging on to outdated imperialist dogma which
        perpetuates the economic and social differences in our society.

        @type peasant: Person
        @param peasant: Person to repress.
        """
        peasant.knock_over()   # Shows a warning. And there was much rejoicing.

相关部分是@type peasant: Person文档字符串的行。

如果您还转到“文件”>“设置”>“ Python集成工具”，并将“文档字符串格式”设置为“
Epytext”，则PyCharm的“视图”>“快速文档查找”将漂亮地打印参数信息，而不是仅按原样打印所有@ -lines。

Answer 1

是的，您可以对方法及其参数使用特殊的文档格式，以便PyCharm可以知道类型。最新的PyCharm版本支持大多数常见的doc格式。

例如，PyCharm从@param样式注释中提取类型。

另请参见reStructuredText和docstring约定（PEP
257）。

另一个选择是Python 3注释。

请参阅PyCharm文档部分以获取更多详细信息和示例。