对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
投稿猜你喜欢
Yahoo发布了一款基于FireFox的插件，名叫YSlow，这个插件可以分析网站的页面，并告诉你为了提高网站性能，如何基于某些规则而进行优- 使用JS实现在图片上显示左右箭头的翻页代码，预览效果网址：http://www.keleyi.com/keleyi/phtml/picnex
- 地图服务是指可以提供数据信息的接口，比如说本地搜索/路线规划等，下面小编给大家整理下百度地图API之本地搜索和范围搜索，具体请看下文。地图服
- 一、re.compile 函数作用：compile 函数用于编译正则表达式，生成一个正则表达式（ Pattern ）对象，供 match()
- 前面是分部讲解，完整代码在最后。导入模块 ：import osfrom shutil import copy, rmtreeimport r
- 安装pip install faker使用简单使用本库可生成姓名、地址、电话、邮箱、公司等等一系列数据。首先导入库，实例化：from fak
- 如下所示：#Copyright (c)2017, 东北大学软件学院学生# All rightsreserved#文件名称：a.py# 作 &
- 命名空间单例模式是JavaScript中最常见的一种模式，通过这种模式可以为我们提供一个命名空间，例如jQuery库的命名空间为jQuery
- 所有人都知道select top 的用法，但很多人还不知道update top 和 delete top 怎么用。以往的做法是set row
- 直方图的定义直方图的性质只统计某个灰度级出现的次数，图像的大小不一样的话， 某灰度值的像素出现的次数是不一样的。那如果我们在这基础上除以像素
- 查询mysql表是否被损坏命令，如下：# CHECK TABLE 表名mysql的长期使用，肯定会出现一些问题，一般情况下mysql表无法访
- 一、python numpy + matplotlib 画股票k线图# -- coding: utf-8 --import requests
- 一、基础第三方库使用1.基本使用方法"""例"""from urllib imp
- 什么是模式前阵子准备期末考试，劳神又伤身的，实在闲不得空来更新文章，今天和大家说说javascript中的设计模式。首先呢，我们需要知道的是
- 本文实例讲述了python实现批量获取指定文件夹下的所有文件的厂商信息的方法。分享给大家供大家参考。具体如下：功能代码如下：import o
- 什么是生产者消费者模型在 工作中，大家可能会碰到这样一种情况：某个模块负责产生数据，这些数据由另一个模块来负责处理（此处的模块是广义的，可以
- PHP simplexml_load_file() 函数实例转换 XML 文件为 SimpleXMLElement 对象，然后输出对象的键和
- 本文实例为大家分享了小程序自定义弹出框效果的具体代码，供大家参考，具体内容如下my-pop----api：title ------字符串--
- 题目描述给定一个整数数组 nums 和一个整数目标值 target，请你在该数组中找出 和为目标值 target 的那 两个 整数，并返回它
- 一、单因素分析线性拟合功能：线性拟合，单因素分析，对散点图进行线性拟合，并放大散点图的局部位置输入：某个xlsx文件，包含'患者密度
