如何使用Python生成文档？

文档提高了代码的可读性。有许多工具可以帮助我们创建文档。一种这样的工具是pdoc 为Python项目编写文档。

安装：在终端上运行以下pip命令。

pip3 install pdoc3

现在（通过命令行）导航到我们的Python程序所在的文件夹。假设我们的程序名称是 Numbers.py。它是一个简单的类，有 2 个函数，一个用于查找数字的阶乘，另一个用于检查数字是否为质数。

Python3

class Numbers :
   
        """
        This class will be used to perform operations on numbers.
        To find out their factorial, check whether the number is prime
        """
   
        def isPrime(self, number) :
   
                '''
                A method to check whether a number is prime
                '''
   
                i = 2
                while(i <= number / 2) :
                        if number % i == 0:
                                return False
                        i += 1
                return True
          
        def factorial(self, number) :
              
                """
                A function that finds out the factorial of numbers
                """
                result = 1
                while(number >= 2) :
                        result *= number
                        number -= 1
                return result

在类和方法中添加文档字符串提供了一种将文档与Python模块、函数、类和方法相关联的便捷方式。文档字符串是文档的重要组成部分。

导航到保存我们的代码 (Numbers.py) 的文件夹（通过命令行）后。我们必须在终端中输入这个命令：

pdoc --html Numbers.py

目录结构

触发上面显示的 –html 命令后，将在保存 Numbers.py 的目录中创建一个 HTML 文件夹。在该 HTML 文件夹中，将创建一个名为 Numbers.html 的文件。导航到 HTML 文件夹并打开 Numbers.html。

数字.html

Numbers.html 应该是这样的。我们刚刚创建了类 Numbers 的正确文档。在 Number.html 的左列（索引）中，可以看到类及其方法。记住我们写的文档字符串，它们在它们各自的类和方法下面可用。