python面向对象之注释篇

类的描述与项目文档生成

参考文献：【Python】零基础入门——面向对象编程（强烈推荐）_哔哩哔哩_bilibili

类的描述

• 目的

  • 方便理清逻辑思路

  • 方便多人合作开发时的沟通

  • 方便生成项目文档

# 首先打三个”直接回车，直接将该类的作用，构造函数，类属性的描述,方法同理，但方法会自动把你的参数进行直接生成，您需要做的是加上参数的含义 参数的类型，是否有默认值，同时加上该方法的效果和相关的作用，包括其返回的数据的含义及其返回数据的类型。
class Student：
	"""
	Attributes:
	"""
    # 这个学生的年龄，默认为18岁
	age =18
    def study():
        """
        
        """
        print("I am learning")
        pass
    pass
# 得到该类的描述文档，可以直接使用如下语句： 但明显不适用
help(Student)

上面的方法明显不适用，如果要生成更好的注释文档，可以使用内置模块pydoc，具体步骤如下：

• 首先打开【运行】程序，找到要导出的目录，可以在程序里面找到项目路径，然后cd 到项目路径，回车

• 查看文档：python 3 -m pydoc 模块名称

  • python 3 -m pydoc -h # 开启一个help

• 启动本地服务，浏览文档 python3 -m pydoc -p 55244 # 指定端口55244打开html文件进行查看

• 生成指定模块html文档 python3 -m pydoc -w 模块名称 # 直接生成某一个模块的说明文档（html文件）