python有一種獨一無二的的注釋方式：使用文件字串，文件字串是包、模組、類或函式裡的第乙個語句，這些字串可以通過物件的__doc__成員被自動提取，並且被pydoc所用。
1、注釋文件
2、檢視python的模組和函式幫助文件方法
1、注釋文件
乙個文件字串應該這樣組織：首先是一行以句號，問號或驚嘆號結尾的概述(或者該文件字串單純只有一行)。接著是乙個空行，接著是文件字串剩下的部分，它應該與文件字串的第一行的第乙個引號對齊。
#!/usr/bin/env python# -*-coding:utf-8 -*-
# annotation.py
''' 文件快速生成注釋的方法介紹,首先我們要用到__all__屬性在py中使用為匯出__all__中的所有類、函式、變數成員等在模組使用__all__屬性可避免相互引用時命名衝突'''
__all__
= ['login'
, 'check'
, 'shop'
, 'updateit'
, 'findit'
, 'deleteit'
, 'createit']
class
login:
''' 測試注釋一可以寫上此類的作用說明等 例如此方法用來寫登入 '''
def__init__
(self):
''' 初始化你要的引數說明 '''
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):
''' 建立新商品及上架資訊 '''
可以通過，__doc__訪問任何函式，類，模組中文件注釋。
1）訪問模組注釋
2）訪問類注釋
3）訪問函式注釋
4）修改__doc__
這種修改並不修改文件內容本身。
2、檢視python的模組和函式幫助文件方法
這裡介紹下python自帶的檢視幫助功能，可以在程式設計時不中斷地迅速找到所需模組和函式的使用方法。
help(模組名)，檢視對性完整注釋
dir(模組名)，檢視物件屬性
參考文章 1、
python快速生成注釋文件的方法
Python快速生成注釋文件
python為我們生成基本滿足的說明文件，一來可以提高 整體閱讀性，二來可以將 的整體結構看著也更清晰。簡單的 格式 usr bin env python coding utf 8 文件快速生成注釋的方法介紹,首先我們要用到 all 屬性 在py中使用為匯出 all 中的所有類 函式 變數成員等 在...
自動生成頭注釋檔案
進行有關程式方面工作的都知道，一段簡潔易懂質量高的 離不開注釋的強有力輔助，在團隊合作開發中注釋更是發揮著舉足輕重的作用。但是我們常常對那些重複性的諸如頭部注釋這樣的注釋感到疲憊不堪。下面我們就以頭部注釋為例進行 自動生成重複注釋 諸如頭部注釋 的方法講解。自動生成頭部注釋其實挺簡單的，主要是對系統...
python 迴圈語句與注釋 檔案讀寫學習總結
一 python迴圈語句 實現功能 1 基本的求和 while 2 想經常使用 使用函式 定義函式 def 3 想獲取運算的結果和 加返回值 return 4 函式呼叫者想算自定義的和 增加介面開年 5 求指定範圍內的奇數 偶數的和 6 求等差數列的和 7 增加預設引數 求start end的和 d...