对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的Django框架中编写错误提示页面
Jul 22 Python
python版本坑:md5例子(python2与python3中md5区别)
Jun 20 Python
Python实现购物系统(示例讲解)
Sep 13 Python
python 正确保留多位小数的实例
Jul 16 Python
python 发送和接收ActiveMQ消息的实例
Jan 30 Python
利用Python对文件夹下图片数据进行批量改名的代码实例
Feb 21 Python
Python深拷贝与浅拷贝用法实例分析
May 05 Python
对pytorch中的梯度更新方法详解
Aug 20 Python
Python面向对象之继承原理与用法案例分析
Dec 31 Python
Python列表倒序输出及其效率详解
Mar 04 Python
python json.dumps() json.dump()的区别详解
Jul 14 Python
Python 获取异常(Exception)信息的几种方法
Dec 29 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
模仿OSO的论坛(二)
2006/10/09 PHP
php学习笔记 php中面向对象三大特性之一[封装性]的应用
2011/06/13 PHP
基于PHP中的常用函数回顾
2013/07/11 PHP
laravel 配置路由 api和web定义的路由的区别详解
2019/09/03 PHP
VBScript版代码高亮
2006/06/26 Javascript
滚动经典最新话题[prototype框架]下编写
2006/10/03 Javascript
使用jQuery动态加载js脚本文件的方法
2014/04/03 Javascript
javascript字母大小写转换的4个函数详解
2014/05/09 Javascript
jquery 插件实现瀑布流图片展示实例
2015/04/03 Javascript
在Node.js应用中读写Redis数据库的简单方法
2015/06/30 Javascript
深入浅析JavaScript中对事件的三种监听方式
2015/09/29 Javascript
AngularJS基础 ng-list 指令详解及示例代码
2016/08/02 Javascript
seajs模块之间依赖的加载以及模块的执行
2016/10/21 Javascript
Bootstrap基本插件学习笔记之模态对话框(16)
2016/12/08 Javascript
Node.js v8.0.0正式发布!看看带来了哪些主要新特性
2017/06/02 Javascript
jQuery实现仿京东防抖动菜单效果示例
2018/07/06 jQuery
详解javascript appendChild()的完整功能
2018/08/18 Javascript
vue.js自定义组件directives的实例代码
2018/11/09 Javascript
javascript json字符串到json对象转义问题
2019/01/22 Javascript
在微信小程序中保存网络图片
2019/02/12 Javascript
js中arguments对象的深入理解
2019/05/14 Javascript
深入了解Hybrid App技术的相关知识
2019/07/17 Javascript
node.js中对Event Loop事件循环的理解与应用实例分析
2020/02/14 Javascript
[01:01:52]完美世界DOTA2联赛PWL S2 GXR vs Magma 第二场 11.25
2020/11/26 DOTA
使用PDB模式调试Python程序介绍
2015/04/05 Python
Python实现通讯录功能
2018/02/22 Python
Python网络编程使用select实现socket全双工异步通信功能示例
2018/04/09 Python
python用插值法绘制平滑曲线
2021/02/19 Python
Python Pillow(PIL)库的用法详解
2020/09/19 Python
深入浅出CSS3 background-clip,background-origin和border-image教程
2011/01/27 HTML / CSS
Static Nested Class 和 Inner Class的不同
2013/11/28 面试题
数控技校生自我鉴定
2014/04/19 职场文书
大学生社会实践评语
2014/04/25 职场文书
2014小学年度工作总结
2014/12/20 职场文书
《分一些蚊子进来》读后感3篇
2020/01/09 职场文书
Python 统计序列中元素的出现频度
2022/04/26 Python