python學習筆記-為自訂類別或函數編寫help文檔，以及進行文檔測試

在python中我們可以利用help("模組名稱")或help(類別名稱)的方式來檢視類別或函數的文件。但是它們是如何寫的呢？其實它們在類別最前面或方法的最前面用"""三個雙引號包裹了多行註解。這些內容就會被Python當成幫助文件。

那幫助文件一般會寫什麼內容呢？主要包括以下內容：

該類別或函數的主要作用

傳入的值和輸出的值

一些特殊情況的文件說明

以上內容是個人的總結，但是並沒有看到相關的資料。註解中我們也可以doctest模組進行文件測驗。測試只有在以入口文件執行的時候才會進行文檔測試。文件測試的內容，更多相關內容請關注PHP中文網（www.php.cn）！