我可以让IDLE shell向我展示一个函数的描述吗?

时间:2013-01-02 10:13:45

标签: python python-3.x python-2.7

所以我是Python的新手,我正在使用IDLE。我使用什么命令,所以Python shell(在按下f5之后)向我展示了描述(我在函数名后面的“”“”“中写的东西) 和/或显示其他功能的描述!?

如果它在2.7和3.3中有所不同,我很感激,如果你提到它。

4 个答案:

答案 0 :(得分:2)

您在“”“”“中写的内容称为docstring。

如果要打印此内容,可以使用该类型的__doc__属性。 (类型表示类,方法或模块)。

您可以使用内置函数dir

检查可用属性

答案 1 :(得分:1)

您使用:

help(your_function_name)

就像我在这里做的那样:

>>> def sayhello():
    """This says hello to you"""
    print "Hello there!"

>>> help(sayhello)
Help on function sayhello in module __main__:

sayhello()
    This says hello to you

编辑: 您必须先导入自己的模块。

答案 2 :(得分:1)

“thing”被称为Docstring,可以通过字典属性__ doc __轻松访问

>>> def testfunc():
...     """ My Docstrings """
...     print "test"
... 

>>> testfunc.__doc__
' My Docstrings '

答案 3 :(得分:0)

使用help()函数

示例:

  
    
      

帮助(打印)       内置模块内置功能的打印帮助:

    
  

打印(...)     print(value,...,sep ='',end ='\ n',file = sys.stdout,flush = False)

Prints the values to a stream, or to sys.stdout by default.
Optional keyword arguments:
file:  a file-like object (stream); defaults to the current sys.stdout.
sep:   string inserted between values, default a space.
end:   string appended after the last value, default a newline.
flush: whether to forcibly flush the stream.