当前位置: 首页 > 编程笔记 >

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

鱼恩
2023-03-14
本文向大家介绍Python快速从注释生成文档的方法,包括了Python快速从注释生成文档的方法的使用技巧和注意事项,需要的朋友参考一下

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

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

一看别人专业的大牛们写的文档多牛多羡慕,不用担心我们可以让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常用的导入方式from从哪个目录import导入什么文件pythonzhushi

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

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

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

 类似资料:
  • 注释 在 Rust 里面注释分成两种,行注释和块注释。它的形式和 C 语言是一样的。 两种注释分别是: 行注释使用 // 放在注释前面。比如: // I love Rust, but I hate Rustc. 块注释分别使用/*和*/包裹需要注释的内容。比如: /* W-Cat 是个大胖猫,N-Cat 是个高度近视猫。*/ 文档 Rust 自带有文档功能的注释,分别是///和//!。支持 Mar

  • 本文向大家介绍Java的文档注释之生成帮助文档的实例,包括了Java的文档注释之生成帮助文档的实例的使用技巧和注意事项,需要的朋友参考一下 示例: 生成命令 注意Person.java路径名要正确。 效果: 其中index.html为主页,打开如下图: 以上这篇Java的文档注释之生成帮助文档的实例就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持呐喊教程。

  • 本文向大家介绍Android Studio 实现文档注释的快捷键,包括了Android Studio 实现文档注释的快捷键的使用技巧和注意事项,需要的朋友参考一下 文档注释 添加文档注释是一个好的编程习惯,AS提供快速生成文档注释的方法。 方法1:/** + 回车 在函数上方输入 “/** ” 然后回车,自动生成文档注释。 方法2:快捷键 我这里设置的快捷键是 ctrl + / 补充知识:andr

  • 主要内容:Javadoc标签,Javadoc命令,DOS命令生成API帮助文档 ,MyEclipse生成API帮助文档,文档注释的格式Java 支持 3 种注释,分别是单行注释、多行注释和文档注释。文档注释以 开头,并以 结束,可以通过 Javadoc 生成 API 帮助文档,Java 帮助文档主要用来说明类、成员变量和方法的功能。 文档注释只放在类、接口、成员变量、方法之前,因为 Javadoc 只处理这些地方的文档注释,而忽略其它地方的文档注释。 Javadoc 是 Sun 公司提供的一种工

  • 问题内容: 我设法在Swift中为注解图钉获得了一个自定义图标,但是现在我仍然对2个不同的注解使用不同的图像。现在,一个按钮会在地图上添加注释。应该有另一个按钮,该按钮也添加了注释,但带有另一个图标。 有没有办法为此使用复用ID? 问题答案: 在委托方法中,设置调用该方法所基于的依据。 一定要做到这一点 后 视图被出队或创建的(而不是只在部分)。否则,使用出队视图的注释将显示以前使用该视图的注释的

  • 本文向大家介绍python如何快速生成时间戳,包括了python如何快速生成时间戳的使用技巧和注意事项,需要的朋友参考一下 结果是 知识点扩展: 获取秒级时间戳与毫秒级时间戳、微秒级时间戳 返回 获取当前日期时间 返回 到此这篇关于python如何快速生成时间戳的文章就介绍到这了,更多相关python生成时间戳的简单方法内容请搜索呐喊教程以前的文章或继续浏览下面的相关文章希望大家以后多多支持呐喊教