通过完美python注释,打印类的帮助文档

非常完美的python注释

这里直接举例如何写注释。包括类,方法,属性的注释,每种注释需要包含哪些内容,注释好了之后,怎么生成一个类的文档

比较常用的注释写法

# -*- coding:utf-8  -*-
class Person():
    """
    这是一个Person,人类
    Attributes:
        name: str 姓名
        age: int 年龄
    """
    name = "张三"
    age = 0

    def speak(self, languare="中文"):
        """
        说话的方法
        :param languare: 字符串,语言类型,默认值:中文
        :return: 字符串,返回这个人对应语言的 你好,世界
        """
        if languare == "中文":
            return "你好世界!"
        elif languare == "英文":
            return "hello world!"
# 这个方法可以生成类的文档
help(Person)

在这里插入图片描述
注意

  • 对于返回值类型,一定要写,方便别人调用后对数据进行处理
  • 属性因为在attributes中没有办法显示注释的含义,所以可以再类注释下面用Attributes类似的些成我的代码示例中这样,也可方便查看

生成注释文档

python有一个模块pydoc可以生成HTML格式的注释文档
在这里插入图片描述
使用方法:
python -m pydoc -p 1234(这个会指定端口)
然后会提示是否打开,输入b就可以了

更简单的方法是
python -m pydoc -b (直接就使用了未占用的端口,启动一个本地的服务器给你查看文档)
在这里插入图片描述
这个方法会直接吧所有的模块的帮助文档都显示出来,当然,也可以指定,参数具体使用可以自行查看
在这里插入图片描述

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值