对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判断变量名是否合法的方法示例

Python判断变量名是否合法的方法示例

问题: 变量名是否合法:          1.变量名可以由字母,数字或者下划线组成   &nb...

简单谈谈python中的lambda表达式

最近在coding时发现使用lambda还是有诸多优点的,很多时候代码更整洁,更pythonic,所以在此简单总结一下 1.lambda是什么 举个简单的例子: func = lam...

python添加模块搜索路径和包的导入方法

python添加模块搜索路径和包的导入方法

方法一:函数添加 1 import sys 2 查看sys.path 3 添加sys.path.append("c:\\") 方法二:修改环境变量 w用户可以修改系统环境变量PYTHO...

Python生成随机数组的方法小结

Python生成随机数组的方法小结

本文实例讲述了Python生成随机数组的方法。分享给大家供大家参考,具体如下: 研究排序问题的时候常常需要生成随机数组来验证自己排序算法的正确性和性能,今天把Python生成随机数组的方...

使用Python和Prometheus跟踪天气的使用方法

开源监控系统 Prometheus 集成了跟踪多种类型的时间序列数据,但如果没有集成你想要的数据,那么很容易构建一个。一个经常使用的例子使用云端提供商的自定义集成,它使用提供商的 API...