Python 3.1 快速導覽 - 類別 __doc__

類別 (class) 有 __doc__ 屬性 (attribute) ,這是三引號字串定義的文字,屬於類別的說明文件。三引號字串的形式如下

"""frist line
second line"""


三引號字串可以跨行,印出時會以字串 (string) 原始編排形式顯示。


我們先來看看一些常用資料型態 (data type) 的例子
a = 22 #1
print(a.__doc__)
print()

a = 22.0 #2
print(a.__doc__)
print()

a = "22" #3
print(a.__doc__)
print()

a = [22] #4
print(a.__doc__)

# 《程式語言教學誌》的範例程式
# http://pydoing.blogspot.com/
# 檔名:cla09.py
# 功能:示範 Python 程式 
# 作者:張凱慶
# 時間:西元 2010 年 12 月 


執行結果如下



第 1 組
a = 22 #1
print(a.__doc__)


a 為整數 (integer) ,另有內建函數 (function) int() 可將其他型態轉換為整數。


第 2 組
a = 22.0 #2
print(a.__doc__)


a 為浮點數 (floating-point number) ,另有內建函數 float() 可將其他型態轉換為浮點數。


第 3 組
a = "22" #3
print(a.__doc__)


a 為字串,另有內建函數 str() 可將其他型態轉換為字串。


第 4 組
a = [22] #4
print(a.__doc__)


a 為串列,另有內建函數 list() 可將其他型態轉換為串列 (list) 。


下例我們替 Demo 加入 __doc__ 屬性
class Demo:
    """
Demo - 
        learning Python class..."""

    def __init__(self, i):
        self.i = i
    
    def __str__(self):
        return str(self.i)
         
    def hello(self):
        print("hello", self.i)

a = Demo(1122)
a.hello()
print()
print(a.__doc__)

# 《程式語言教學誌》的範例程式
# http://pydoing.blogspot.com/
# 檔名:cla10.py
# 功能:示範 Python 程式 
# 作者:張凱慶
# 時間:西元 2010 年 12 月 



執行結果如下



通常三引號字串會直接放在 class 下方,利用 __doc__ 即可存取。


中英文術語對照
類別class
屬性attribute
字串string
資料型態data type
整數integer
函數function
浮點數floating-point number
串列list






沒有留言: