Python快速从注释生成文档的方法


Posted in Python onDecember 26, 2016

作为一个标准的程序猿,为程序编写说明文档是一步必不可少的工作,如何才能写的又好又快呢,下面我们就来详细探讨下吧。

今天将告诉大家一个简单平时只要注意的小细节,就可以轻松生成注释文档,也可以检查我们写的类方法引用名称是否重复有问题等。

一看别人专业的大牛们写的文档多牛多羡慕,不用担心我们可以让python为我们生成基本满足的说明文档,一来可以提高代码整体阅读性,二来可以将代码的整体结构看着也更清晰,这样在交接的时候可以省很多麻烦,其它同事在接手你工作的时候也不会一行行去问你这是什么那是什么的,因为注释已经很直观的表述了,在整合的时候可当说明文档给客户简单说明(主要是给你BOSS看的).

那么进入正题怎么实现看下面我简单的代码格式,注意注释的地方和函数名类名都是与__all__内相关联的

#!/usr/bin/env python

# -*-coding:utf-8 -*-

'''

 
文档快速生成注释的方法介绍,首先我们要用到__all__属性

在Py中使用为导出__all__中的所有类、函数、变量成员等

在模块使用__all__属性可避免相互引用时命名冲突

'''

__all__ = ['Login', 'check', 'Shop', 'upDateIt', 'findIt', 'deleteIt', 'createIt']

class Login:

'''

测试注释一可以写上此类的作用说明等

例如此方法用来写登录

'''

def __init__(self):

'''

初始化你要的参数说明

那么登录可能要用到

用户名username

密码password

'''

pass

def check(self):

'''

协商你要实现的功能说明

功能也有很多例如验证

判断语句,验证码之类的

'''

pass

class Shop:

'''

商品类所包含的属性及方法

update改/更新

find查找

delete删除

create添加

'''

def __init__(self):

'''

初始化商品的价格、日期、分类等

'''

pass

def upDateIt(self):

'''

用来更新商品信息

'''

pass

def findIt(self):

'''

查找商品信息

'''

pass

def deleteIt(self):

'''

删除过期下架商品信息

'''

pass

def createIt(self):

'''

创建新商品及上架信息

'''

pass

if __name__=="__main__":

import pythonzhushi

print help(pythonzhushi)

这里要强调说明下py的名字要和你当前工作的py名字一样(我这里创建的py名字就是pythonzhushi,最后导入也是这名字),因为下面的测试中import的导入的是自身所以,im port 名称 和Help(名称)以及你的文件名称要一致才可以。为了更加直观请看下面这图:

Python快速从注释生成文档的方法

当然还可以从其它文件引用的方式导入这里用到python常用的导入方式from从哪个目录import导入什么文件pythonzhushi

当然我这里还是用图片来展示以下:

Python快速从注释生成文档的方法

是不是一目了然,这样也可以导入我们需要做的注释文档,help帮助方法就是帮我们查看到此文件中所包含的类,函数,的一个简单帮助文档,类似于readme文档的一个说明。最后来看看掩饰效果吧:

Python快速从注释生成文档的方法

Python快速从注释生成文档的方法

是不是简单的打印出我们程序的说明文档,后面步骤直接可以建一个文本把这个粘贴过去,就完成一个readme的文档说明,经过测试有几点注意是,想要写#这种注释不要写到def放发内要写到它的上面位置和装饰器类似,相反三引号'''不要写到def外面,这样也是没显示效果的。大家赶紧去试试吧。感谢观看。。

Python 相关文章推荐
在Python中使用列表生成式的教程
Apr 27 Python
python实现自动解数独小程序
Jan 21 Python
基于OpenCV python3实现证件照换背景的方法
Mar 22 Python
python通过txt文件批量安装依赖包的实现步骤
Aug 13 Python
Python使用微信接入图灵机器人过程解析
Nov 04 Python
python 字典套字典或列表的示例
Dec 16 Python
Python实现图像的垂直投影示例
Jan 17 Python
最新2019Pycharm安装教程 亲测
Feb 28 Python
OpenCV 使用imread()函数读取图片的六种正确姿势
Jul 09 Python
python openCV自制绘画板
Oct 27 Python
python 使用csv模块读写csv格式文件的示例
Dec 02 Python
Python第三方库安装缓慢的解决方法
Feb 06 Python
浅谈Python类的__getitem__和__setitem__特殊方法
Dec 25 #Python
解决pyqt中ui编译成窗体.py中文乱码的问题
Dec 23 #Python
详解python进行mp3格式判断
Dec 23 #Python
详解python发送各类邮件的主要方法
Dec 22 #Python
详解python 发送邮件实例代码
Dec 22 #Python
使用Python3 编写简单信用卡管理程序
Dec 21 #Python
Python 遍历子文件和所有子文件夹的代码实例
Dec 21 #Python
You might like
php实现四舍五入的方法小结
2015/03/03 PHP
Yii2框架引用bootstrap中日期插件yii2-date-picker的方法
2016/01/09 PHP
yii2中结合gridview如何使用modal弹窗实例代码详解
2016/06/12 PHP
解析PHP之提取多维数组指定列的方法
2017/01/03 PHP
PHP验证码类ValidateCode解析
2017/01/07 PHP
PHP字典树(Trie树)定义与实现方法示例
2017/10/09 PHP
PHP 实现链式操作
2021/03/09 PHP
firefox插件Firebug的使用教程
2010/01/02 Javascript
在UpdatePanel内jquery easyui效果失效的解决方法
2010/04/11 Javascript
JS 两日期相减,获得天数的小例子(兼容IE,FF)
2013/07/01 Javascript
不使用jquery实现js打字效果示例分享
2014/01/19 Javascript
EasyUI闪屏EasyUI页面加载提示(原理+代码+效果图)
2016/02/21 Javascript
JS中的==运算: [''] == false —>true
2016/07/24 Javascript
微信小程序开发之入门实例教程篇
2017/03/07 Javascript
基于JavaScript实现数码时钟效果
2020/03/30 Javascript
vue调用语音播放的方法
2019/09/27 Javascript
es6中使用map简化复杂条件判断操作实例详解
2020/02/19 Javascript
如何在 Vue 中使用 JSX
2021/02/14 Vue.js
在Ubuntu系统下安装使用Python的GUI工具wxPython
2016/02/18 Python
python django 增删改查操作 数据库Mysql
2017/07/27 Python
Python实现读取SQLServer数据并插入到MongoDB数据库的方法示例
2018/06/09 Python
Python中修改字符串的四种方法
2018/11/02 Python
python根据txt文本批量创建文件夹
2020/12/08 Python
在linux系统下安装python librtmp包的实现方法
2019/07/22 Python
Tensorflow 1.0之后模型文件、权重数值的读取方式
2020/02/12 Python
Scrapy框架介绍之Puppeteer渲染的使用
2020/06/19 Python
Python实现一个论文下载器的过程
2021/01/18 Python
匡威荷兰官方网站:Converse荷兰
2018/10/24 全球购物
承认错误的检讨书
2014/01/30 职场文书
认购协议书范本
2014/04/22 职场文书
幼儿园门卫岗位职责范本
2014/07/02 职场文书
公司人事专员岗位职责
2014/08/11 职场文书
学校做一个有道德的人活动方案
2014/08/23 职场文书
2015年小学语文教学工作总结
2015/05/25 职场文书
2015年店长个人工作总结
2015/10/23 职场文书
Mysql数据库中datetime、bigint、timestamp来表示时间选择,谁来存储时间效率最高
2021/08/23 MySQL