全網最適合入門的物件導向程式設計教程：35 Python 的內建資料型別-文件字串和__doc__屬性
摘要：
在 Python 中，文件字串（Docstring）是一種用於為模組、類、方法或函式編寫文件的字串，通常放置在定義的開頭，緊跟在宣告之後。文件字串使用三重引號（""" 或 '''）包圍，可以跨越多行。
原文連結：
FreakStudio的部落格
往期推薦：
學嵌入式的你，還不會物件導向？？！
全網最適合入門的物件導向程式設計教程：00 物件導向設計方法導論
全網最適合入門的物件導向程式設計教程：01 物件導向程式設計的基本概念
全網最適合入門的物件導向程式設計教程：02 類和物件的 Python 實現-使用 Python 建立類
全網最適合入門的物件導向程式設計教程：03 類和物件的 Python 實現-為自定義類新增屬性
全網最適合入門的物件導向程式設計教程：04 類和物件的Python實現-為自定義類新增方法
全網最適合入門的物件導向程式設計教程：05 類和物件的Python實現-PyCharm程式碼標籤
全網最適合入門的物件導向程式設計教程：06 類和物件的Python實現-自定義類的資料封裝
全網最適合入門的物件導向程式設計教程：07 類和物件的Python實現-型別註解
全網最適合入門的物件導向程式設計教程：08 類和物件的Python實現-@property裝飾器
全網最適合入門的物件導向程式設計教程：09 類和物件的Python實現-類之間的關係
全網最適合入門的物件導向程式設計教程：10 類和物件的Python實現-類的繼承和里氏替換原則
全網最適合入門的物件導向程式設計教程：11 類和物件的Python實現-子類呼叫父類方法
全網最適合入門的物件導向程式設計教程：12 類和物件的Python實現-Python使用logging模組輸出程式執行日誌
全網最適合入門的物件導向程式設計教程：13 類和物件的Python實現-視覺化閱讀程式碼神器Sourcetrail的安裝使用
全網最適合入門的物件導向程式設計教程：全網最適合入門的物件導向程式設計教程：14 類和物件的Python實現-類的靜態方法和類方法
全網最適合入門的物件導向程式設計教程：15 類和物件的 Python 實現-__slots__魔法方法
全網最適合入門的物件導向程式設計教程：16 類和物件的Python實現-多型、方法重寫與開閉原則
全網最適合入門的物件導向程式設計教程：17 類和物件的Python實現-鴨子型別與“file-like object“
全網最適合入門的物件導向程式設計教程：18 類和物件的Python實現-多重繼承與PyQtGraph串列埠資料繪製曲線圖
全網最適合入門的物件導向程式設計教程：19 類和物件的 Python 實現-使用 PyCharm 自動生成檔案註釋和函式註釋
全網最適合入門的物件導向程式設計教程：20 類和物件的Python實現-組合關係的實現與CSV檔案儲存
全網最適合入門的物件導向程式設計教程：21 類和物件的Python實現-多檔案的組織：模組module和包package
全網最適合入門的物件導向程式設計教程：22 類和物件的Python實現-異常和語法錯誤
全網最適合入門的物件導向程式設計教程：23 類和物件的Python實現-丟擲異常
全網最適合入門的物件導向程式設計教程：24 類和物件的Python實現-異常的捕獲與處理
全網最適合入門的物件導向程式設計教程：25 類和物件的Python實現-Python判斷輸入資料型別
全網最適合入門的物件導向程式設計教程：26 類和物件的Python實現-上下文管理器和with語句
全網最適合入門的物件導向程式設計教程：27 類和物件的Python實現-Python中異常層級與自定義異常類的實現
全網最適合入門的物件導向程式設計教程：28 類和物件的Python實現-Python程式設計原則、哲學和規範大彙總
全網最適合入門的物件導向程式設計教程：29 類和物件的Python實現-斷言與防禦性程式設計和help函式的使用
全網最適合入門的物件導向程式設計教程：30 Python的內建資料型別-object根類
全網最適合入門的物件導向程式設計教程：31 Python的內建資料型別-物件Object和型別Type
全網最適合入門的物件導向程式設計教程：32 Python的內建資料型別-類Class和例項Instance
全網最適合入門的物件導向程式設計教程：33 Python的內建資料型別-物件Object和型別Type的關係
全網最適合入門的物件導向程式設計教程：34 Python的內建資料型別-Python常用複合資料型別：元組和命名元組
更多精彩內容可看：
給你的 Python 加加速：一文速通 Python 平行計算
一文搞懂 CM3 微控制器除錯原理
肝了半個月，嵌入式技術棧大彙總出爐
電子計算機類比賽的“武林秘籍”
一個MicroPython的開源專案集錦：awesome-micropython，包含各個方面的Micropython工具庫
文件和程式碼獲取：
可訪問如下連結進行對文件下載：
https://github.com/leezisheng/Doc
本文件主要介紹如何使用 Python 進行物件導向程式設計，需要讀者對 Python 語法和微控制器開發具有基本瞭解。相比其他講解 Python 物件導向程式設計的部落格或書籍而言，本文件更加詳細、側重於嵌入式上位機應用，以上位機和下位機的常見串列埠資料收發、資料處理、動態圖繪製等為應用例項，同時使用 Sourcetrail 程式碼軟體對程式碼進行視覺化閱讀便於讀者理解。
相關示例程式碼獲取連結如下：https://github.com/leezisheng/Python-OOP-Demo
正文
在 Python 中，我們可以為方法、類和模組新增文件字串，這些文件字串可以透過一個特殊屬性__doc__獲取。文件字串（docstring）是一種用於描述類、函式、模組或方法的字串，通常位於定義的頂部，並用於提供有關其功能和用法的資訊。文件字串通常被包含在三引號（''' 或 """）中，並位於類、函式、模組或方法定義的頂部。
例如，在下列示例中，我們為 MasterClass 主機類及其 StartMaster 開啟主機方法新增必要註釋，並透過以下語句訪問：
_# 訪問MasterClass類的__doc__屬性_
print(MasterClass.__doc__)
_# 訪問MasterClass類中StartMaster方法的__doc__屬性_
print(MasterClass.StartMaster.__doc__)
示例程式碼如下：
class MasterClass(SerialClass,PlotClass):
'''
MasterClass：該類表示主機類，主要用於接收感測器資料、收發指令等
具有如下屬性：
state —— 表示主機工作狀態
port —— 表示主機埠號
wintitle —— 表示視窗標題
... ...
具有如下方法：
StartMaster —— 開啟主機
StopMaster —— 停止主機
RecvSensorValue —— 接收感測器資料值
... ...
'''
...
_# 類的初始化_
def __init__(self,state:int = IDLE_STATE,port:str = "COM17",wintitle:str="Basic plotting examples",plottitle:str="Updating plot",width:int=1000,height:int=600):
pass
_# 開啟主機_
def StartMaster(self):
'''
StartMaster方法——開啟主機
呼叫SerialClass.OpenSerial()方法
:return: 無返回值
'''
pass
如下為執行結果：
同時，我們也可以給命名元組新增文件字串。使用一個類繼承對應的命名元組，並在類中新增文件註釋，示例程式碼如下：
from collections import namedtuple
_Sensor = namedtuple("Sensor","ID CURRENTVALUE MAXVALUE MINVALUE")
class Sensor(_Sensor):
'''
這是一個繼承自表示感測器資料的命名元組的類
具有四個屬性：
（1） ID ： 表示感測器ID號
（2） CURRENTVALUE ： 感測器採集到的當前資料值
（3） MAXVALUE ： 感測器採集到的最大資料值
（4） MINVALUE ： 感測器採集到的最小資料值
'''
sensor_tuple=Sensor(ID="16",CURRENTVALUE=32,MAXVALUE=62,MINVALUE=2)
print(sensor_tuple.__doc__)
執行結果如下：
