python中的帮助_python中的帮助

1. Windows Powershell

在shell下，帮助可以用

> python -m pydoc [function]

查看函数的定义

例如，想查print函数的定义，只要键入

>python -m pydoc print

就可以查看了

但是这个方法是不能查看某个方法的。比如想查关闭文件的.close()方法，键入

>python -m pydoc close

会报错：no Python documentation found for ' close'

2.Python Shell

在Python shell里面如何使用帮助呢？

有个函数可以帮助你: help()

>python

键入

>>> help('print')

可以帮你查看print函数的定义statement

当我们键入

>>>help("help")

时，我们可以看到help可以查看modules, keywords,或者topics

那如果想查一个方法，比如查split()的意思怎么办呢？

先定义一个值(字符串)

>>>a = ""

>>>a

''

>>>help(a.split)

就可以查看split的用法了

但是，这不是最终的解决方案。所谓方法，是针对一类东西的方法。（原谅我刚学习这个，表达不太清楚）。比如split是对字符串的处理方法。所以在使用帮助的时候应该键入

>>>help(str.split)

str表示字符串spring

如果想查pop()的意义呢？我们发现pop其实是对list (列表)的一种处理方法，那么使用help时就应该键入

>>>help(list.pop)

锵锵~~查询成功

所以!! 当在linux下或者windows powershell下时，方法也就可以查询了哦！键入

>python -m pydoc list.pop

锵锵~~完美运行

3. 用help查看函数定义

假设我们写了一个含有多个函数的.py文件 ex25.py 想看看函数到底有哪些，是什么样的，怎么做呢？

一，进入python

> python

二，import  .py文件

>>>import ex25

三，help查看

>>>help(ex25)

结果如下

多说一句，函数的注释是怎么来的呢？答案是在def定义函数时使用三引号""" 引用，如下所示:

def break_words(stuff):

"""This function will break up words for us."""

words = stuff.split(' ')

return words

三引号里面的内容就会显示在help的结果中。这个三引号引用的特别字符串叫作 documentation comments.

请注意，只有在第一行使用三引号做documentation comments才有效。在其他地方写没有用....(亲测)

如果想查询这个文件中某一个函数的帮助，则可以使用

>>>help(ex25.break_words)

待续......