通过完美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 （直接就使用了未占用的端口，启动一个本地的服务器给你查看文档）

这个方法会直接吧所有的模块的帮助文档都显示出来，当然，也可以指定，参数具体使用可以自行查看