python docstring必须作为文字字符串给出; 但有时为几个函数(例如,不同的构造函数)创建类似的文档字符串是有用的,或者几个访问方法可能接受相同的参数列表(然后依赖于相同的隐藏方法),因此使用相同的描述会很好到处.对于这种情况,我可以通过赋值来构造文档字符串__doc__,我通过简单的装饰器来完成.系统工作得非常好(在python 2中),我很高兴它是多么简单,清晰和封装良好.
问题:这是个好主意吗?特别是,是否存在会被此设置混淆的工具(例如,从源提取文档字符串而不是从字节码中提取文档字符串的任何内容).解决方案仍然可以在python 3中运行吗?还有其他原因或情况会导致这种情况不明智吗?
它不应该破坏任何工具并且应该可以在 Python 3 上运行。
没关系,如果它不损害源代码的可读性,即,您仍然可以找到该函数的作用以及如何使用它。
问题可能在于它掩盖了糟糕的设计。如果多个方法使用相同的参数列表,则应该重构代码(创建一个与该列表一起使用的对象),而不是通过生成重复的文档字符串来修补。