您似乎可以在两个地方放置类的文档字符串:
class MyClass(object):
""" Summary of MyClass
Body
...
"""
__init__
构造函数下:...
def __init__(self, arg1, arg2):
""" Summary of MyClass
Body
...
"""
哪个是首选?还是两者都可以吗?
它们都可以存在,因为它们都旨在用于不同的事物。
类的文档字符串应总结其行为,并列出公共方法和实例变量。如果该类打算被子类化,并且具有子类的附加接口,则该接口应单独列出(在文档字符串中)。类构造函数的方法应记录在文档字符串中
__init__
。各个方法应使用自己的文档字符串记录。
强调我的。此参考资料来自PEP 257-Docstring约定
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句