这里有新鲜出炉的 Python3 官方中文指南, 程序狗速度看过来!
Python 编程语言
Python 是一种面向对象, 解释型计算机程序设计语言, 由 Guido van Rossum 于 1989 年底发明, 第一个公开发行版发行于 1991 年. Python 语法简洁而清晰, 具有丰富和强大的类库. 它常被昵称为胶水语言, 它能够把用其他语言制作的各种模块 (尤其是 C/C++) 很轻松地联结在一起.
今天小编就为大家分享一篇对 python 的文件内注释 help 注释方法, 具有很好的参考价值, 希望对大家有所帮助. 一起跟随小编过来看看吧
目的:
在 help(模块名)时, 能够看见文件里面的注释.
首先, 在文件的最开头, 如果有个多行注释(三引号), 就会将注释写入__DOC__变量, 在 help 查看时, 可以看见这个变量.
如果还需要输出函数, 则可以将函数放入__all__变量.
__all__ = ['search','fix','hello','parser']
all 里面的元素是唯一的, 所以, 这里要避免函数重名. 当然, python 对函数的重载也不是很提倡......
这样在 python 命令行, 可以看见注释了.
比如一个程序是 test02.py, 先 import 它, 再看
help(test02)
或者在程序中调用 print(help(test02))
源代码:
- #test02.py
- """
- author:Zhao Zhenyu
- this is an absolute test program.
- """__all__ = ["function1","function2"]
- def function1():
- pass
- def function2():
- """2nd
- """
- pass
执行情况:
- >>> import test02
- >>> help(test02)
- Help on module test02:
- NAME
- test02
- DESCRIPTION
- author:Zhao Zhenyu
- this is an absolute test program.
- FUNCTIONS
- function1()
- function2()
- 2nd
- DATA
- __all__ = ['function1', 'function2']
- FILE
c:\users\lenovo\documents\python scripts\python_spider\csdn 例子 \ test02.py
>>>
来源: http://www.phperz.com/article/19/0514/365998.html