Python文档字符串中要包含什么?
我想知道python文档字符串包括哪些内容?比如,如果我想记录某个类,我应该在文档字符串中为该类写些什么?根据: 类的docstring应该总结其行为并列出 公共方法和实例变量。如果该类的目的是 子类,并为子类提供了一个附加接口 接口应单独列出(在docstring中)。班级 构造函数的Python文档字符串中要包含什么?,python,class,object,Python,Class,Object,我想知道python文档字符串包括哪些内容?比如,如果我想记录某个类,我应该在文档字符串中为该类写些什么?根据: 类的docstring应该总结其行为并列出 公共方法和实例变量。如果该类的目的是 子类,并为子类提供了一个附加接口 接口应单独列出(在docstring中)。班级 构造函数的\uuuu init\uuuuu 方法。个别方法应自行记录 文件串 如果一个类是另一个类的子类,并且它的行为主要是 继承自该类,其docstring应该提到 总结差异。使用动词“override”表示 子类方法替
\uuuu init\uuuuu
方法。个别方法应自行记录
文件串
如果一个类是另一个类的子类,并且它的行为主要是
继承自该类,其docstring应该提到
总结差异。使用动词“override”表示
子类方法替换超类方法,并且不调用
超类方法;使用动词“extend”表示子类
方法调用超类方法(除了它自己的行为之外)
根据:
类的docstring应该总结其行为并列出
公共方法和实例变量。如果该类的目的是
子类,并为子类提供了一个附加接口
接口应单独列出(在docstring中)。班级
构造函数的\uuuu init\uuuuu
方法。个别方法应自行记录
文件串
如果一个类是另一个类的子类,并且它的行为主要是
继承自该类,其docstring应该提到
总结差异。使用动词“override”表示
子类方法替换超类方法,并且不调用
超类方法;使用动词“extend”表示子类
方法调用超类方法(除了它自己的行为之外)
那帮了大忙!非常感谢你!那帮了大忙!非常感谢你!