Bootstrap

面向对象编程——类的描述与项目文档

        在python中,类的描述和文档是确保代码可读性,可维护性和团队协作效率的关键环节。好的类描述和项目文档能够帮助开发者快速理解代码结构,功能和使用方法。

class Person:
    """
    关于这个类的描述,类的作用,类的构造函数等等;类属性描述
    """
    #这个表示的是人的个数
    count = 1

    def run(self,distance,step):
        """
        在函数里面打三个引号回车就会自动生成
        这个方法的作用效果
        :param distance:  参数的含义,参数的类型int,是否有默认值
        :param step:
        :return: 返回的结果的含义(时间),返回数据类型int
        """
        print("人在跑")
        return distance/step

#这个是用来查看Person类的描述
help(Person

生成项目文档

生成项目文档有两种方式:

方式1:使用内置模块pydoc

方式2:使用第三方库Sphinx,epydoc,doxygen


在这里我们只介绍内置模块pydoc的使用:

具体步骤:

查看文档描述:python3 -m pydoc 模块名称

启动本地服务,浏览文档:python3 -m pydoc -p 1234

生成指定模块html文档:python3 -m pydoc -w 模块名称

首先,在电脑本地打开cmd工具。

然后,找到文件的所在目录,然后再cmd命令框中(cd 路径)切换到指定路径。

然后,我们在文件目录下输入命令python3 -m pydoc -h,会出现相关帮助文档

在这里我们查看一个模块的文档。

这里就会输出文件下的对应文档。

其他命令就不在这里一 一赘述。在这里我们主要展示python3 -m pydoc -p 命令。

然后,我们输入b,进行浏览,就会在浏览器里面自动的出现浏览界面。

;