python - 向 python 模块添加帮助

Question

我使用 Spyder，例如 numpy。然后，当我使用某些功能时，比如np.interp()，对象检查器为我提供有关此功能的帮助。如何将文档放入我的模块中，该模块将显示在 Spyder 的对象检查器中？

Answer 1

这将是 python 文档注释:

"""
This module contains methods and classes
"""

class class_:
    """
    This class is well... a class
    """
    def method(self, in_):
        """
        This method takes one argument: in_ and returns it
        """
        return in_