pydoc是python自帶的乙個文件生成工具，使用pydoc可以很方便的檢視類和方法結構
命令【python3 -m pydoc -p 1234】
通過http://localhost:1234來訪問檢視文件
說明：1、-p指定啟動的服務的埠號，可以隨意指定不衝突的埠號
2、只有在自建的工程根目錄下使用該命令，才能看到當前工程下所有的內容，否則只能看到python環境變數下的模組內容
3、如果本地只有乙個python，可以直接使用【pydoc -p 埠號】啟動，但因為我本地有python2和python3，所以指定了用python3
例子：新建了乙個py檔案叫做testpydoc.py，進入testpydoc.py所在目錄
python3 -m pydoc testpydoc
例子：新建了乙個py檔案叫做testpydoc.py，進入testpydoc.py所在目錄
python3 -m pydoc -w testpydoc
會預設將當前目錄下的testpydoc生成乙個叫做testpydoc.html的文件，如果是目錄直接【python3 -m pydoc -w 目錄名】生成文件
說明：如果是將整個目錄生成這種格式，不建議用這種方式，因為如果他展示目錄下的子檔案的說明時，會去子目錄下找對應.html檔案，如果檔案不存在，就會404
例如如下命令：
python3 -m pydoc -k testpydoc
結果如下：
testpydoc - @author 每天1990
通過檢視文件的方法，我們可以看到在html的文件主要分成四部分：py檔案的頂部注釋、classes、functions、data
（示例**見結尾部分）
注釋內如果包含了模組檔案內的class名，或方法名()，則顯示藍色，且可以點選跳轉到對應說明位置
1.只能展示class下的注釋，不會展示class下方法的注釋
2.class上面有#注釋時，展示#號的注釋
3.class下有」」」多行注釋」」」時優先展示多行注釋，就不展示頂部的#號的注釋了
1.function上面有#注釋時，展示#號的注釋
2.function下有」」」多行注釋」」」時優先展示多行注釋，就不展示頂部的#號的注釋了
示例**：
"""@author 每天1990
@desc 本模組是乙個測試檔案，用來說明pydoc的讀取內容
@date 2017/4/13
說明：classes:testclass()，具有function1()和function2()兩個方法
function：test1()，test2()，test3()
data：a，b
"""#注釋放在方法名前，使用#號注釋
def test1(a):
print("注釋放在方法名前")
#注釋放在方法名前，使用#號注釋
def test2():
"""注釋放在方法內的第一行，既有#號又有多行注釋時，優先展示多行注釋
"""print("既有#號又有多行注釋時，優先展示多行注釋 ")
def test3():
#在方法第一行內使用#注釋
print("在方法內使用#號注釋，不生效")
class testclass():
"""注釋生效順序與方法一致，優先展示類下的多行注釋，如果沒有才展示類上面的#號注釋
類下的方法的注釋不會展示出來
"""def function1(self):#類下方法的注釋不會展示
print("類下的第乙個方法")
def function2(self,a):
print("類下的第二個引數，包含a引數")
a=1#變數的注釋不會展示出來
b=2通過上面的文件說明，我們可以合理的注釋，有助於了解工程結構
1.單行注釋：使用#號進行注釋
#單行注釋
2.多行注釋：使用三個雙引號或單引號來注釋多行內容
'''單引號進行多行注釋
'''"""
雙引號進行多行注釋
"""在functions和classes前面加#注釋，或者在function和class第一行內加三個單引號或三個雙引號進行注釋
如果有三個引號的注釋方法，會優先使用三個點的注釋，其次才展示#號的注釋
注意：如果在方法或class定義後第一行使用#注釋是拉取不到注釋的
例子1：class前有#號注釋，class內有多行注釋，pydoc會優先展示三個點內的注釋
例子2：方法內使用#號注釋，pydoc不會顯示注釋內容（class同理）
例子3：方法或class沒有多行注釋，只在方法外有#號注釋時，會展示定義前的#號內的內容
例子4：模組頂部的內容，優先展示多行注釋中的內容
python注釋規範 動態注釋和靜態注釋
對python進行注釋可以提高 的規範，也能提高效率。這其中包括對函式 類等之間的快速的注釋，另一方面包括對注釋內容的規範書寫。python主要包括兩部分 一 是單行和多行的注釋 二 是 的注釋規則 一 python單行注釋符號 其中 右邊的內容不會輸出，用於對單行注釋。使用的快捷鍵是 ctrl 二...
規範 前端編碼規範 注釋規範
頂部新增檔案申明資訊，包括檔案描述 原始作者，如果有更新，則需要新增更新內容 更新作者和更新時間。description 說明文字 author 張三 description 說明文字 author 張三 update 更新內容 by 李四 2013 04 13 18 32 無論是單行注釋還是多行注...
Python命名，注釋等編碼規範
1.1 命名規範包名 全部小寫字母，中間可以由點分隔開，不推薦使用下滑線。模組名 全部小寫字母，如果多個單詞構成，可以用下劃線隔開。如dummy threading.類名 採用大駝峰法命名。如splitviewcontroller異常名 異常屬於類，命名同類命名，但應以error作為字尾。如file...