对python的文件内注释 help注释方法

yipeiwu_com7年前Python基础

目的:

在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
>>>

以上这篇对python的文件内注释 help注释方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持【听图阁-专注于Python设计】。

相关文章

Python 获取 datax 执行结果保存到数据库的方法

执行 datax 作业,创建执行文件,在 crontab 中每天1点(下面有关系)执行: 其中 job_start 及 job_finish 这两行记录是自己添加的,为了方便识别出哪张表...

对django views中 request, response的常用操作详解

request 获取post请求中的json数据 def hello(request): data = json.loads(request.body) ... json格式还...

PyQt5 实现字体大小自适应分辨率的方法

最近遇到一个现象,将做好的软件放在更高分辨率的电脑上运行,会导致字体显示不完全,出现被控件遮挡的情况。具体原因可以上网查询,在这里将记录下解决方法。 这里记录两种方法,如果使用的Qt版本...

OpenCV 轮廓检测的实现方法

OpenCV 轮廓检测的实现方法

轮廓概述 轮廓可以简单认为成将连续的点(连着边界)连在一起的曲线,具有相同的颜色或者灰度。轮廓在形状分析和物体的检测和识别中很有用。  为了更加准确,要使用二值化图像...

python求最大连续子数组的和

抛出问题: 求一数组如 l = [0, 1, 2, 3, -4, 5, -6],求该数组的最大连续子数组的和 如结果为[0,1,2,3,-4,5] 的和为7 问题分析: 这个问题很...