Python文档字符串必须以字面字符串的形式给出;但有时为几个函数(例如,不同的构造函数)提供类似的文档字符串很有用,或者几个访问方法可能接受相同的参数列表(然后依赖于相同的隐藏方法),因此最好在所有地方使用相同的描述。对于这种情况,我可以通过分配给__doc__
来构造一个文档字符串,我通过一个简单的装饰器来实现。该系统在python 2中非常好用,我很高兴它是如此简单,清晰和封装。
问题:这是个好主意吗?特别是,是否有工具会被这种设置所困惑(例如,从源代码而不是从字节码提取文档字符串的任何内容)。这个解决方案在python 3中仍然有效吗?是否存在其他原因或情况使得这种做法不可取?
__init__
。 - Karl Knechtel