python教程—如何在Python中记录字段和属性?-Python实用宝典

python教程—如何在Python中记录字段和属性?

用Python编写类或方法的文档很容易:但是如何编写字段或属性的文档,以便在API文档或帮助中使用呢?

用Python编写类或方法的文档很容易:

    class Something: """ Description of the class. """ def do_it(self): """ Description of the method. """ pass class_variable = 1 # How to comment? @property def give_me_some_special_dict(self): """ doesn't work! Doc of general dict will be shown. """ return {}

但是如何在API文档或帮助中记录字段或属性的使用呢?

回答

Python有一个定义文档字符串约定的PEP (257)。关于属性的文件,它说:

字符串文字立即出现
在顶部完成一个简单的任务之后
模块、类或……init__的级别
方法称为“属性”
文档字符串”。

因此,以下属性被认为是文档化的属性:

    class Foo(object): velocity = 1 """Foo's initial velocity - class variable""" def __init__(self, args): self.location = 0.0 """Foo's initial location - instance variable"""

(编辑:固定的第二个文档字符串)

​Python实用宝典 (pythondict.com)
不只是一个宝典
欢迎关注公众号:Python实用宝典

本文由 Python实用宝典 作者:Python实用宝典 发表,其版权均为 Python实用宝典 所有,文章内容系作者个人观点,不代表 Python实用宝典 对观点赞同或支持。如需转载,请注明文章来源。
0

发表评论