Python程式設計：使用pydoc生成文檔注釋

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用法