pydoc是python自帶的一個文件生成工具，可以提取註釋

如果有三個引號的註釋方法，會優先使用三個點的註釋，其次才展示#號的註釋

示例使用的程式碼pydoc_demo.py，包含一個函式，一個類

# -*- coding: utf-8 -*-

# @Date    : 2018-10-30
# @Author  : Peng Shiyu

"""
這個文件註釋pydoc的示例
"""

# 函式名上方的文字
def func():
    """
    函式名下方的註釋
    @return: None
    """
    print("hello")


# 類名上方的文字
 

class Demo():
    """
    類名下方的文字
    """

    # 類中方法上方的文字
    def hello(self):
        """
        類中方法下方的文字
        @return: None
        """
        print("hello")

生成文件

$ pydoc pydoc_demo > doc.md

將文件重定向到doc.md檔案中，內容如下

Help on module pydoc_demo:

NAME
    pydoc_demo - 這個文件註釋pydoc的示例

CLASSES
    builtins.
 
object
        Demo
    
    class Demo(builtins.object)
     |  類名下方的文字
     |  
     |  Methods defined here:
     |  
     |  hello(self)
     |      類中方法下方的文字
     |      @return: None
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
 

     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)

FUNCTIONS
    func()
        函式名下方的註釋
        @return: None

FILE
   /demo/pydoc_demo.py

生成html

$ pydoc -w pydoc_demo

出現新檔案pydoc_demo.html

顏色看上去很鮮豔

參考
pydoc用法