【发布时间】:2016-02-03 22:04:57
【问题描述】:
我最近开始使用 PyCharm,它使用我想开始使用的文档字符串支持 Python 2.x 的类型提示。
类Foo 的__init__ 方法的:return: 值应该是多少?
我找不到答案是否应该是 Foo、None、什么都没有,还是删除 PyCharm 在文档字符串模板中为我创建的属性?
【问题讨论】:
-
__init__不应该返回任何东西,也不太可能被分配,所以你放什么并不重要。如果您的方法不是return,您可以删除:return:条目,因为它始终是None。事实上,我通常记录类本身而不是__init__,它通常不需要自己的文档字符串。
标签: python python-2.7 docstring