Sphinx:共享函数文档字符串

问题描述

我想在多个类中重用用于同一函数的文档字符串。

例如

class square:
     def getArea(L,W):
     """ [description]
     L (int) ... 
     W (int) ... 

     return (int) area of shape
     """
     return L*W

 class rectangle:
     def getArea(L,W):
     """ use docstring from above"""
     return L*W

有没有办法在多个函数中使用相同的文档字符串?这是一个简单的例子,但有些函数有 10 个不同的参数,能够使用相同的文档字符串将确保一致性。

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)