对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 ip正则式
May 07 Python
django 解决manage.py migrate无效的问题
May 27 Python
解决Python 中英文混输格式对齐的问题
Jul 16 Python
实例讲解Python中整数的最大值输出
Mar 17 Python
python实现的按要求生成手机号功能示例
Oct 08 Python
python 利用turtle模块画出没有角的方格
Nov 23 Python
NumPy中的维度Axis详解
Nov 26 Python
python代码实现图书管理系统
Nov 30 Python
flask框架中的cookie和session使用
Jan 31 Python
python实现计算图形面积
Feb 22 Python
python基于tkinter制作无损音乐下载工具
Mar 29 Python
微信小程序调用python模型
Apr 21 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命令行用法入门实例教程
2014/10/27 PHP
php多重接口的实现方法
2015/06/20 PHP
调试WordPress中定时任务的相关PHP脚本示例
2015/12/10 PHP
php与c 实现按行读取文件实例代码
2017/01/03 PHP
PHP编程中的Session阻塞问题与解决方法分析
2017/08/07 PHP
浅谈PHP中如何实现Hook机制
2017/11/14 PHP
php过滤htmlspecialchars() 函数实现把预定义的字符转换为 HTML 实体用法分析
2019/06/25 PHP
Aliyun Linux 编译安装 php7.3 tengine2.3.2 mysql8.0 redis5的过程详解
2020/10/20 PHP
取得传值的函数
2006/10/27 Javascript
从零开始学习jQuery (六) jquery中的AJAX使用
2011/02/23 Javascript
javascript制作网页图片上实现下雨效果
2015/02/26 Javascript
JavaScript基本语法学习教程
2016/01/14 Javascript
jQuery基于Ajax方式提交表单功能示例
2017/02/10 Javascript
bootstrap3 dialog 更强大、更灵活的模态框
2017/04/20 Javascript
React实践之Tree组件的使用方法
2017/09/30 Javascript
js中的闭包学习心得
2018/02/06 Javascript
vue2.0学习之axios的封装与vuex介绍
2018/05/28 Javascript
小程序实现留言板
2018/11/02 Javascript
vue中axios防止多次触发终止多次请求的示例代码(防抖)
2020/02/16 Javascript
《javascript设计模式》学习笔记七:Javascript面向对象程序设计组合模式详解
2020/04/08 Javascript
[03:09]DOTA2亚洲邀请赛 LGD战队出场宣传片
2015/02/07 DOTA
Python实现的矩阵类实例
2017/08/22 Python
Python 3.x读写csv文件中数字的方法示例
2017/08/29 Python
Python中实现switch功能实例解析
2018/01/11 Python
Python爬取豆瓣视频信息代码实例
2019/11/16 Python
python实现UDP协议下的文件传输
2020/03/20 Python
python自动打开浏览器下载zip并提取内容写入excel
2021/01/04 Python
使用CSS3制作版头动画效果
2020/12/24 HTML / CSS
数控专业应届生求职信
2013/11/27 职场文书
中医专业职业生涯规划书范文
2014/01/04 职场文书
索桥的故事教学反思
2014/02/06 职场文书
大学生党员自我批评
2014/02/14 职场文书
我爱祖国演讲稿
2014/09/02 职场文书
2014年民主评议党员工作总结
2014/12/02 职场文书
工作报告范文
2019/06/20 职场文书
利用Python第三方库实现预测NBA比赛结果
2021/06/21 Python