Question

我很久以来一直在使用这种奇怪的语法，而且我已经相当擅长了。这就像抓住了Java的优点，并在Python中拥有它。它很棒，我喜欢它，我的IDE甚至因为注释而遇到了一些错误。

我不知道是谁指定了这种语法，它是如何正式的，而且我不知道它的确切规则。

不可否认，我使用的是PyCharm，但我不知道这是否可以在其他IDE中使用，或者它只是PyCharm语法 - 我不想这么想是的，我也想使用适用于其他工具的docstring语法。

此外，我看到亚马逊人在他们的python库中使用这种语法： https://github.com/boto/boto/blob/develop/boto/beanstalk/layer1.py#L83

这是语法的一个例子。

def asdf(name, descriptions, weird_dict):
    """
    :type weird_dict: dict[tuple[str|None],list[dict[int,str]|MyClass]]
    :param weird_dict: description description

    :type name: str
    :param list[str] descriptions: Description and type annotation

    :param str name: Here I declared the "suggested" type, and can also describe the param

    :return:  Here I just describe what's returned
    :rtype: int
    """

请告诉我，如果有人知道，这个语法的名称是什么，谁指定了它，以及我如何能够找到更多关于它的信息，因为我尝试了几次并且刚刚结束了PyCharm网站。

Answer 1

这是PEP 287指定的reStructuredText Docstring Format

PyCharm在Python Integrated Tools设置

下也有以下文档字符串格式

我已经使用这个docstring语法2年了，它叫什么，谁指定了它，它是＆＃34; ok＆＃34;用吗？

1 个答案: