[英]Python DocString (Google Style): How to document class attributes?
我有这个小例子:
"""Sandbox module"""
class Toto:
"""
This class is an example
Attributes:
class_attribute (str): The class attribute #Unresolved reference
instance_attribute (str): The instance attribute #OK
"""
class_attribute = ""
def __init__(self):
self.instance_attribute = ""
pass
这会触发未解决的参考警告我应该如何正确记录 class 属性?
尝试这个:
"""
Sandbox module
~~~~~~~~~~~~~~
"""
class Toto:
"""This class is an example
Attributes:
instance_attribute (str): The instance attribute #OK
"""
#: str: The class attribute #Unresolved reference
class_attribute = ""
def __init__(self):
self.instance_attribute = ""
pass
这对使用狮身人面像的我来说很好。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.