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


Posted in Python onMay 23, 2018

目的:

在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在windows下实现备份程序实例
Jul 04 Python
Python通过正则表达式选取callback的方法
Jul 18 Python
Python简单实现子网掩码转换的方法
Apr 13 Python
Python图算法实例分析
Aug 13 Python
Python 提取dict转换为xml/json/table并输出的实现代码
Aug 28 Python
Python探索之Metaclass初步了解
Oct 28 Python
浅谈Django的缓存机制
Aug 23 Python
Python Pillow Image Invert
Jan 22 Python
python opencv实现图像边缘检测
Apr 29 Python
深入浅析Python科学计算库Scipy及安装步骤
Oct 12 Python
pandas factorize实现将字符串特征转化为数字特征
Dec 19 Python
python seaborn heatmap可视化相关性矩阵实例
Jun 03 Python
Python基于生成器迭代实现的八皇后问题示例
May 23 #Python
Pycharm 操作Django Model的简单运用方法
May 23 #Python
PyCharm代码格式调整方法
May 23 #Python
创建pycharm的自定义python模板方法
May 23 #Python
对Python中9种生成新对象的方法总结
May 23 #Python
使用pycharm生成代码模板的实例
May 23 #Python
pycharm设置注释颜色的方法
May 23 #Python
You might like
php使用codebase生成随机数
2014/03/25 PHP
3款值得推荐的微信开发开源框架
2014/10/28 PHP
PHP程序中的文件锁、互斥锁、读写锁使用技巧解析
2016/03/21 PHP
thinkPHP模板引擎用法示例
2016/12/08 PHP
PHP attributes()函数讲解
2019/02/03 PHP
Laravel中正确地返回HTTP状态码方法示例
2019/09/10 PHP
JavaScript 验证码的实例代码(附效果图)
2013/03/22 Javascript
jquery 定位input元素的几种方法小结
2013/07/28 Javascript
angularJS提交表单(form)
2015/02/09 Javascript
js前端导出Excel的方法
2017/11/01 Javascript
详解webpack-dev-server使用http-proxy解决跨域问题
2018/01/13 Javascript
webpack组织模块打包Library的原理及实现
2018/03/10 Javascript
vue改变对象或数组时的刷新机制的方法总结
2019/04/24 Javascript
微信小程序select下拉框实现效果
2019/05/15 Javascript
[03:43]2014DOTA2西雅图国际邀请赛 newbee战队巡礼
2014/07/07 DOTA
Windows下用py2exe将Python程序打包成exe程序的教程
2015/04/08 Python
python获取指定路径下所有指定后缀文件的方法
2015/05/26 Python
python变量不能以数字打头详解
2016/07/06 Python
python 实现自动远程登陆scp文件实例代码
2017/03/13 Python
利用numpy+matplotlib绘图的基本操作教程
2017/05/03 Python
Python内置函数—vars的具体使用方法
2017/12/04 Python
Python cookbook(数据结构与算法)将序列分解为单独变量的方法
2018/02/13 Python
Django REST framework 分页的实现代码
2019/06/19 Python
django与vue的完美结合_实现前后端的分离开发之后在整合的方法
2019/08/12 Python
python实现图书馆抢座(自动预约)功能的示例代码
2020/09/29 Python
美国家具网站:Cymax
2016/09/17 全球购物
小班下学期评语
2014/05/04 职场文书
幼儿园爱国卫生月活动总结
2014/06/30 职场文书
2014银行领导班子四风对照检查材料思想汇报
2014/09/25 职场文书
群众路线问题查摆对照检查材料
2014/10/04 职场文书
2015年师德师风承诺书
2015/01/22 职场文书
民间借贷借条范本
2015/05/25 职场文书
学校教学管理制度
2015/08/06 职场文书
2016年优秀共青团员事迹材料
2016/02/25 职场文书
如何制作自己的原生JavaScript路由
2021/05/05 Javascript
Mysql中常用的join连接方式
2022/05/11 MySQL