【问题标题】:Meaning of comments " classdocs" and "constructor"注释“classdocs”和“constructor”的含义
【发布时间】:2019-08-07 11:25:32
【问题描述】:

我有来自另一个人的代码,我正在尝试理解这些代码。我注意到经常出现的一件事是:

''' 类文档''' (这出现在“class Chronometer”之类的下面)

'''构造函数'''(出现在类的方法中,通常作为第一个方法的一部分)

但没有其他符合条件的信息,在 python 的上下文中,我在网上找不到与这些相关的任何信息。这些是什么意思?

【问题讨论】:

    标签: python python-3.x class


    【解决方案1】:

    Classdocs = 类文档 = 开发人员编写的解释类如何工作的文本。这可能是一个多行字符串(用三引号括起来),其中包含开发人员认为有用的任何信息。标准是把这个直接放在类定义的下面,例如:

    class Foo(Bar):
    """This is my Foo class. It works by
    taking the parameters A and B and
    doing something with them."""
    def method_a(self):
    # . . .
    

    类构造函数 = 在编程中,这是解释类的每个实例在“构造”时的行为方式的代码部分,即我的实例刚刚具有的属性和默认值实例化。在 Python 中,这通常意味着 __init__ 方法,但我见过有人调用一个类方法,它也调用 __init__ 作为构造函数。

    【讨论】:

    • 因此,在此代码的情况下,“classdocs”和“constructor”的三重括号内没有其他文档/文本。我的理解是这对于构造函数是正常的(因为这只是说明它所属的 init 方法是构造函数),但这对于类文档来说是不正常的,因为通常这后面跟着一个解释这段文字的作用?
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2019-04-04
    • 1970-01-01
    • 1970-01-01
    • 2010-10-15
    • 2014-11-12
    相关资源
    最近更新 更多