每個物件都會有一個__doc__屬性,用於描述該物件的作用。在一個模組被import時,其檔案中的某些特殊的字串會被python直譯器儲存在相應物件的__doc__屬性中。比如,一個模組有模組的__doc__,一個class或function也有其對應的__doc__屬性。在python中,一個模組其實就是一個.py檔案。在檔案中特殊的地方書寫的字串就是所謂的docstrings,就是將被放到__doc__的內容。這個“特殊的地方”包括:
1. 一個檔案任何一條可執行的程式碼之前 #模組的__doc__
2. 一個類,在類定義語句後,任何可執行程式碼前#類的__doc__
3. 一個函式,在函式定義語句後,任何可執行程式碼前#函式的__doc__
舉個例子:
#use __doc__ 屬性class MyClass: "string." def printSay(): "print say welcome to you." print "say welcome to you."print MyClass.__doc__print MyClass.printSay.__doc__ #輸出結果 string.print say welcome to you.
每個物件都會有一個__doc__屬性,用於描述該物件的作用。在一個模組被import時,其檔案中的某些特殊的字串會被python直譯器儲存在相應物件的__doc__屬性中。比如,一個模組有模組的__doc__,一個class或function也有其對應的__doc__屬性。在python中,一個模組其實就是一個.py檔案。在檔案中特殊的地方書寫的字串就是所謂的docstrings,就是將被放到__doc__的內容。這個“特殊的地方”包括:
1. 一個檔案任何一條可執行的程式碼之前 #模組的__doc__
2. 一個類,在類定義語句後,任何可執行程式碼前#類的__doc__
3. 一個函式,在函式定義語句後,任何可執行程式碼前#函式的__doc__
舉個例子:
#use __doc__ 屬性class MyClass: "string." def printSay(): "print say welcome to you." print "say welcome to you."print MyClass.__doc__print MyClass.printSay.__doc__ #輸出結果 string.print say welcome to you.