python為我們生成基本滿足的說明文件，一來可以提高**整體閱讀性，二來可以將**的整體結構看著也更清晰。
簡單的**格式：
#強調說明下py的名字要和你當前工作的py名字一樣(我這裡建立的py名字就是pythonannotation,最後匯入也是這名字)，因為下面的測試中import的匯入的是自身所以,import 名稱 和help(名稱)以及你的檔名稱要一致才可以。!/usr/bin/env python
#-*-coding:utf-8 -*-
'''文件快速生成注釋的方法介紹,首先我們要用到__all__屬性
在py中使用為匯出__all__中的所有類、函式、變數成員等
在模組使用__all__屬性可避免相互引用時命名衝突
'''__all__ = ['
login
', '
check
', '
shop
', '
updateit
', '
findit
', '
deleteit
', '
createit']
class
login:
'''測試注釋一可以寫上此類的作用說明等
例如此方法用來寫登入
'''def
__init__
(self):
'''初始化你要的引數說明
那麼登入可能要用到
使用者名稱username
密碼password
'''pass
defcheck(self):
'''協商你要實現的功能說明
功能也有很多例如驗證
判斷語句，驗證碼之類的
'''pass
class
shop:
'''商品類所包含的屬性及方法
update改/更新
find查詢
delete刪除
create新增
'''def
__init__
(self):
'''初始化商品的**、日期、分類等
'''pass
defupdateit(self):
'''用來更新商品資訊
'''pass
deffindit(self):
'''查詢商品資訊
'''pass
defdeleteit(self):
'''刪除過期下架商品資訊
'''pass
defcreateit(self):
'''建立新商品及上架資訊
'''pass
if__name__=="
__main__":
import
pythonannotation
print(help(pythonannotation))
為了更加直觀請看下面這圖：
測試效果：
是不是一目了然，這樣也可以匯入我們需要做的注釋文件，help幫助方法就是幫我們檢視到此檔案中所包含的類，函式,的乙個簡單幫助文件，類似於readme文件的乙個說明。
#經過測試有幾點注意：想要寫#這種注釋不要寫到def方法內要寫到它的上面位置和裝飾器類似，相反三引號'''不要寫到def外面,這樣也是沒顯示效果
的。
python注釋文件
python有一種獨一無二的的注釋方式 使用文件字串，文件字串是包 模組 類或函式裡的第乙個語句，這些字串可以通過物件的 doc 成員被自動提取，並且被pydoc所用。1 注釋文件 2 檢視python的模組和函式幫助文件方法 1 注釋文件 乙個文件字串應該這樣組織 首先是一行以句號，問號或驚嘆號結...
自動生成頭注釋檔案
進行有關程式方面工作的都知道，一段簡潔易懂質量高的 離不開注釋的強有力輔助，在團隊合作開發中注釋更是發揮著舉足輕重的作用。但是我們常常對那些重複性的諸如頭部注釋這樣的注釋感到疲憊不堪。下面我們就以頭部注釋為例進行 自動生成重複注釋 諸如頭部注釋 的方法講解。自動生成頭部注釋其實挺簡單的，主要是對系統...
搬運 快速增加文件注釋
準備2個檔案 檔案二，doxygen.rb 準備好之後，兩步配置，一步操作 配置一，開啟thisservice，如上圖，name隨意填寫，將來會出現在右鍵選單，紅框1 把doxygen.rb拽到紅框2，選filter both 紅框3 然後create service，紅框4 配置一完成！配置二，開...