Python快速从注释生成文档的方法-CDA数据分析师官网

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

2018-06-01

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

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

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

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

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

			#!/usr/bin/env python
		
			# -*-coding:utf-8 -*-
		
			'''
		
			文档快速生成注释的方法介绍,首先我们要用到__all__属性
		
			在Py中使用为导出__all__中的所有类、函数、变量成员等
		
			在模块使用__all__属性可避免相互引用时命名冲突
		
			'''
		
			__all__=['Login','check','Shop','upDateIt','findIt','deleteIt','createIt']
		
			classLogin:
		
			'''
		
			测试注释一可以写上此类的作用说明等
		
			例如此方法用来写登录
		
			'''
		
			def__init__(self):
		
			'''
		
			初始化你要的参数说明
		
			那么登录可能要用到
		
			用户名username
		
			密码password
		
			'''
		
			pass
		
			defcheck(self):
		
			'''
		
			协商你要实现的功能说明
		
			功能也有很多例如验证
		
			判断语句，验证码之类的
		
			'''
		
			pass
		
			classShop:
		
			'''
		
			商品类所包含的属性及方法
		
			update改/更新
		
			find查找
		
			delete删除
		
			create添加
		
			'''
		
			def__init__(self):
		
			'''
		
			初始化商品的价格、日期、分类等
		
			'''
		
			pass
		
			defupDateIt(self):
		
			'''
		
			用来更新商品信息
		
			'''
		
			pass
		
			deffindIt(self):
		
			'''
		
			查找商品信息
		
			'''
		
			pass
		
			defdeleteIt(self):
		
			'''
		
			删除过期下架商品信息
		
			'''
		
			pass
		
			defcreateIt(self):
		
			'''
		
			创建新商品及上架信息
		
			'''
		
			pass
		
			if__name__=="__main__":
		
			importpythonzhushi
		
			printhelp(pythonzhushi)