python快速生成注释文档的方法
来源:互联网 发布:node2vec 知乎 编辑:程序博客网 时间:2024/05/22 06:49
原文地址:http://www.cnblogs.com/cookie1026/p/6093188.html
今天将告诉大家一个简单平时只要注意的小细节,就可以轻松生成注释文档,也可以检查我们写的类方法引用名称是否重复有问题等。一看别人专业的大牛们写的文档多牛多羡慕,不用担心我们可以让python为我们生成基本满足的说明文档,一来可以提高代码整体阅读性,二来可以将代码的整体结构看着也更清晰,这样在交接的时候可以省很多麻烦,其它同事在接手你工作的时候也不会一行行去问你这是什么那是什么的,因为注释已经很直观的表述了,在整合的时候可当说明文档给客户简单说明(主要是给你BOSS看的),那么进入正题怎么实现看下面我简单的代码格式,注意注释的地方和函数名类名都是与__all__内相关联的
'''文档快速生成注释的方法介绍,首先我们要用到__all__属性在Py中使用为导出__all__中的所有类、函数、变量成员等在模块使用__all__属性可避免相互引用时命名冲突'''__all__ = ['Login', 'check', 'Shop', 'upDateIt', 'findIt', 'deleteIt', 'createIt']class Login: ''' 测试注释一可以写上此类的作用说明等 例如此方法用来写登录 ''' def __init__(self): ''' 初始化你要的参数说明 那么登录可能要用到 用户名username 密码password ''' pass def check(self): ''' 协商你要实现的功能说明 功能也有很多例如验证 判断语句,验证码之类的 ''' passclass Shop: ''' 商品类所包含的属性及方法 update改/更新 find查找 delete删除 create添加 ''' def __init__(self): ''' 初始化商品的价格、日期、分类等 ''' pass def upDateIt(self): ''' 用来更新商品信息 ''' pass def findIt(self): ''' 查找商品信息 ''' pass def deleteIt(self): ''' 删除过期下架商品信息 ''' pass def createIt(self): ''' 创建新商品及上架信息 ''' passif __name__=="__main__": import pythonzhushi print help(pythonzhushi)这里要强调说明下py的名字要和你当前工作的py名字一样(我这里创建的py名字就是pythonzhushi,最后导入也是这名字),因为下面的测试中import的导入的是自身所以,import 名称 和Help(名称)以及你的文件名称要一致才可以。
当然还可以从其它文件引用的方式导入这里用到python常用的导入方式from从哪个目录import导入什么文件pythonzhushi
help帮助方法就是帮我们查看到此文件中所包含的类,函数,的一个简单帮助文档,类似于readme文档的一个说明。
阅读全文
0 0
- python快速生成注释文档的方法
- 快速生成文档注释快捷键
- eclipse快速生成java方法的注释
- Eclipse中 java 注释文档 的生成方法
- eclipse自动生成get、set方法的文档注释
- MVC WebApi 文档生成注释说明的方法
- sublime3快速生成类或者方法的注释
- java注释文档的生成
- Sphinx将python代码注释生成文档
- sphinx根据python注释生成文档
- 文档注释生成中文doc方法
- Eclipse文档注释生成doc方法
- Myeclipse 快速生成方法头注释
- 使用sphinx快速生成Python API 文档
- C#注释文档生成的HTML问题解决
- 为javadoc文档的包生成注释
- 可以生成自动文档的注释
- doxygen的文档生成,注释规范
- 新博客
- Duilib CPaintManagerUI::RemoveImage 资源泄漏 修复
- Java复用类中正确清理
- 浅谈线性表(二)【帆帆帆笔记系列】
- Java程序员应该了解的10个面向对象设计原则
- python快速生成注释文档的方法
- 数据库调优
- Python|计蒜客——最大子阵列
- NYOJ-7-街区最短路径问题
- React Native的初步接触
- 字符编码
- Java中构造器的初始化
- 【牛客网/动态规划】蘑菇阵:这种题是不能用深搜解决的
- openwrt学习资料