Python,类中的文档字符串

时间:2011-01-21 02:26:40

标签: python

如何在类

中打印文档字符串

对于功能,我可以这样做:

def func():  
    """
     doc string
    """


print func.__doc__

是否可以用类

做同样的事情
class MyClass(object):

    def __init__(self):
        """
        doc string
        """

i = MyClass()  
print i.__doc__

这不起作用。它只打印出None 我正在编写一个文本游戏,我想在不使用print命令的情况下使用doc字符串作为播放器的指令

由于

2 个答案:

答案 0 :(得分:10)

它是None,因为该类没有文档字符串。尝试添加一个:

class MyClass(object):
    """ Documentation for MyClass goes here. """

    def __init__(self):
        """
        doc string
        """

i = MyClass()  
print i.__doc__ # same as MyClass.__doc__

答案 1 :(得分:3)

您为方法MyClass.__init__而不是MyClass定义了文档字符串:

print i.__init__.__doc__

在类声明后放置类的doc字符串:

class MyClass(object):
    ''' MyClass ... '''

总有:

help(i)

在单个文档中获取类和方法doc字符串。