# 为类添加注释 class Operation: """ 添加类的描述,count属性的作用... Attributes[属性]: count:int 初始化值 """ count = 0 def add(self, num1, num2): """ 加法运算 :param num1:加数1[int] :param num2:加数2[int] :return:总和[int] """ print("True") return num1 + num2 help(Operation) # 生成文档生成网页文档
利用Python自带的模块pydoc,讲撰写的注释自动生成html文档
# annotation.py class Operation: """ 添加类的描述,count属性的作用... Attributes: count:int 初始化值 """ count = 0 def add(self, num1, num2): """ 加法运算 :param num1:加数1[int] :param num2:加数2[int] :return:总和[int] """ print("True") return num1 + num2 def sub(num1, num2): """ 减法运算 :param num1: 减数[int] :param num2: 被减数[int] :return: 余数[int] """ print("True") return num1 - num2
打开命令行,进入项目路径
> python -m pydoc -w annotation # 返回值:wrote annotation.html
在项目路径下会出现一个annotation.html文件
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)