对python的文件内注释 help注释方法
作者：tjzzy 发布时间：2021-12-20 18:12:46
标签：python,文件,注释,help
目的：
在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
>>>
来源：https://blog.csdn.net/tjzzy/article/details/70256155
0
投稿猜你喜欢
背景在校园里认证上网很麻烦需要web输入账号密码有时还会忘记web地址此时就需要一个人或者程序帮我们实现，这时我想到用python制作这个程- PDO::setAttributePDO::setAttribute — 设置属性(PHP 5 >= 5.1.0, PECL pdo
- 我就废话不多说了，直接上代码吧！import datetimeimport timedef get_float_time_stamp():
- 类：定义一件事物的抽象特点。对象：类的 实例。成员变量 − 定义在类内部的变量。该变量的值对外是不可见的，但是可以通过成
- 认识模块对于模块，在前面的一些举例中，已经涉及到了，比如曾经有过：import random (获取随机数模块)。为了能够对模块有一个清晰的
- 前言在python中，通过内嵌集成re模块，程序媛们可以直接调用来实现正则匹配。正则表达式模式被编译成一系列的字节码，然后由用C编写的匹配引
- 被AJAX中DOM的操作郁闷了好几天，今天总算搞明白了，自学就是苦啊，苦的一把鼻涕一把泪的，把教训些出来，给后来者提个醒，老鸟就不要看了。下
- 1、Librosaimport librosa filepath = "/Users/birenjianmo/Desktop/le
- 本文描述通过统计分析出医院信息系统需分区的表，对需分区的表选择分区键，即找出包括在你的分区键中的列(表的属性)，对大型数据的管理比较有意义，
- 如何显示数据库里的图片？asp调用数据库中的图片并显示。怎样把数据库里的图片显示出来？我们以gif格式的图片为例，代码如下：showimag
- 页签的流行自从Yahoo!的首页引进页签（tab, 见下图）之后，这种可用性极佳的方式越来越受欢迎，用户也逐步习惯和喜欢上它，因为它可以在原
- 一、使用sklearn转换器处理sklearn提供了model_selection模型选择模块、preprocessing数据预处理模块、d
- 在实验中需要自己构造单独的HTTP数据报文，而使用SOCK_STREAM进行发送数据包，需要进行完整的TCP交互。因此想使用原始套接字进行编
- 最近在研究雨哲软件采集程序的时候，需要获取真实软件地址时遇到了需要读取跳转页面跳转后的真实地址的问题。在网上找了很多方法，使用WinHttp
- 在域环境下我没配置成果，也许是域用户的原因，因为我在生产环境下搞的，更改域用户需要重启SQLServer ，所以这个方法放弃了，只能用证书形
- 浏览器：IE ，不支持firefoxfilter视觉滤镜的种类:Alpha(透明度) Blur(模糊) Chroma(指定颜色透明) Dro
- <?php /** * Created by JetBrains Ph
- ASCII(str) 返回字符串str的第一个字符的ASCII值(str是空串时返回0)mysql> select ASCII(
- 这几天正在为压缩代码的事情所困扰，大家也可以看见，我的博客顶端有两个在线的压缩工具，但在实际应用过程中，除了CSS的压缩比较满意外，JS的压
- blankzheng的blog：http://www.planabc.net/1、使用fieldset和legend标签在form中，我们经
