对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实现希尔排序算法的原理与用法实例分析
Nov 23 Python
Django跨域请求CSRF的方法示例
Nov 11 Python
python 实现数字字符串左侧补零的方法
Dec 04 Python
Python常见数据类型转换操作示例
May 08 Python
python或C++读取指定文件夹下的所有图片
Aug 31 Python
python闭包、深浅拷贝、垃圾回收、with语句知识点汇总
Mar 11 Python
设置jupyter中DataFrame的显示限制方式
Apr 12 Python
Python实现读取并写入Excel文件过程解析
May 27 Python
Pycharm Git 设置方法
Sep 15 Python
python如何构建mock接口服务
Jan 28 Python
Autopep8的使用(python自动编排工具)
Mar 02 Python
详解Python中的for循环
Apr 30 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.NET的入门教程
2006/10/09 PHP
PHP 生成的XML以FLASH获取为乱码终极解决
2009/08/07 PHP
七款最流行的PHP本地服务器分享
2013/02/19 PHP
php使用json_encode对变量json编码
2014/04/07 PHP
一个图片地址分解程序(用于PHP小偷程序)
2014/08/23 PHP
php实现阿拉伯数字和罗马数字相互转换的方法
2015/04/17 PHP
Javascript & DHTML 实例编程(教程)(三)初级实例篇1—上传文件控件实例
2007/06/02 Javascript
jquery 页面全选框实践代码
2010/04/02 Javascript
jquery parent和parents的区别分析
2013/10/02 Javascript
JSF中confirm弹出框的用法示例介绍
2014/01/07 Javascript
Angularjs基础知识及示例汇总
2015/01/22 Javascript
JS操作input标签属性checkbox全选的实现代码
2017/03/02 Javascript
浅析vue深复制
2018/01/29 Javascript
8个有意思的JavaScript面试题
2019/07/30 Javascript
Vue项目结合Vue-layer实现弹框式编辑功能(实例代码)
2020/03/11 Javascript
ant design 日期格式化的实现
2020/10/27 Javascript
[52:39]完美世界DOTA2联赛PWL S3 CPG vs Forest 第一场 12.16
2020/12/17 DOTA
Linux下将Python的Django项目部署到Apache服务器
2015/12/24 Python
理解生产者消费者模型及在Python编程中的运用实例
2016/06/26 Python
python获取酷狗音乐top500的下载地址 MP3格式
2018/04/17 Python
使用pandas对两个dataframe进行join的实例
2018/06/08 Python
Python绘制正余弦函数图像的方法
2018/08/28 Python
Python通过递归获取目录下指定文件代码实例
2019/11/07 Python
HTML5的结构和语义(4):语义性的内联元素
2008/10/17 HTML / CSS
加拿大时装零售商:Influence U
2018/12/22 全球购物
美赞臣营养马来西亚旗舰店:Enfagrow马来西亚
2019/07/26 全球购物
如何用SQL语句进行模糊查找
2015/09/25 面试题
高中自我鉴定范文
2013/11/03 职场文书
18岁生日感言
2014/01/12 职场文书
大学校园毕业自我鉴定
2014/01/15 职场文书
新品发布会策划方案
2014/06/08 职场文书
2015年安全生产管理工作总结
2015/05/25 职场文书
毕业生政审意见范文
2015/06/04 职场文书
高一地理教学工作总结
2015/08/12 职场文书
新学期开学寄语2016
2015/12/04 职场文书
Java反应式框架Reactor中的Mono和Flux
2021/07/25 Java/Android