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使用scrapy采集数据时为每个请求随机分配user-agent的方法
Apr 08 Python
查看TensorFlow checkpoint文件中的变量名和对应值方法
Jun 14 Python
python 输入一个数n,求n个数求乘或求和的实例
Nov 13 Python
Python3 实现文件批量重命名示例代码
Jun 03 Python
python实现雪花飘落效果实例讲解
Jun 18 Python
Python 类属性与实例属性,类对象与实例对象用法分析
Sep 20 Python
python GUI库图形界面开发之PyQt5信号与槽机制、自定义信号基础介绍
Feb 25 Python
python 实现仿微信聊天时间格式化显示的代码
Apr 17 Python
用Python进行websocket接口测试
Oct 16 Python
python集合的新增元素方法整理
Dec 07 Python
教你怎么用Python selenium操作浏览器对象的基础API
Jun 23 Python
opencv深入浅出了解机器学习和深度学习
Mar 17 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中常用编辑器推荐
2007/01/02 PHP
PHP 导出数据到淘宝助手CSV的方法分享
2010/02/27 PHP
解析Linux下Varnish缓存的配置优化
2013/06/20 PHP
深入PHP购物车模块功能分析(函数讲解,附源码)
2013/06/25 PHP
ThinkPHP CURD方法之table方法详解
2014/06/18 PHP
Zend Framework实现多文件上传功能实例
2016/03/21 PHP
JavaScript 操作table,可以新增行和列并且隔一行换背景色代码分享
2013/07/05 Javascript
正负小数点后两位浮点数实现原理及代码
2013/09/06 Javascript
带左右箭头图片轮播的JS代码
2013/12/18 Javascript
JS获取地址栏参数的几种方法小结
2014/02/28 Javascript
jQuery表格插件datatables用法总结
2014/09/05 Javascript
JS+CSS实现的经典tab选项卡效果代码
2015/09/16 Javascript
JS实现漂亮的时间选择框效果
2016/08/20 Javascript
js表单登陆验证示例
2016/10/19 Javascript
AngularJS递归指令实现Tree View效果示例
2016/11/07 Javascript
jQuery Ztree行政地区树状展示(点击加载)
2016/11/09 Javascript
手动初始化Angular的模块与控制器
2016/12/26 Javascript
Vue 过渡实现轮播图效果
2017/03/27 Javascript
详解angularjs4部署文件过大解决过程
2018/12/05 Javascript
jQuery三组基本动画与自定义动画操作实例总结
2020/05/09 jQuery
使用eslint和githooks统一前端风格的技巧
2020/07/29 Javascript
Python3中多线程编程的队列运作示例
2015/04/16 Python
Python面向对象程序设计类的多态用法详解
2019/04/12 Python
浅析Python 引号、注释、字符串
2019/07/25 Python
Python测试线程应用程序过程解析
2019/12/31 Python
Python qrcode 生成一个二维码的实例详解
2020/02/12 Python
Python GUI库PyQt5图形和特效样式QSS介绍
2020/02/25 Python
python+selenium 脚本实现每天自动登记的思路详解
2020/03/11 Python
html5的新增的标签和废除的标签简要概述
2013/02/20 HTML / CSS
美国迪克体育用品商店:DICK’S Sporting Goods
2018/07/24 全球购物
乌克兰网上服装店:Bolf.ua
2018/10/30 全球购物
土木工程师职业规划范文
2014/03/07 职场文书
酒店管理专业自荐信
2014/05/23 职场文书
酒店圣诞节活动总结
2015/05/06 职场文书
焦裕禄纪念馆观后感
2015/06/09 职场文书
2016年政治理论学习心得体会
2016/01/25 职场文书