python社群有自己的**風格建議,遵守它可以使**更加易讀易懂。
文件字串用於作為對某個物件的描述,起到注釋,說明的作用,使**更加易讀,可維護。物件可以是模組,類,方法,函式。
通過在物件的首部位置定義乙個字串字面量表示式的方式定義文件字串,不僅限於"""
多行字串,普通的'
或"
也是可以的。
文件字串首行建議是簡明扼要的一句關於物件的總結,隨後如果還有其他內容,則緊接著空一行,再開始對物件做詳細的描述。
>>
>
def my_function():
..."""do nothing, but document it.
...... no, really, it doesn't do anything.
... """..
.pass..
.>>
>
print
(my_function.__doc__)
do nothing, but document it.
no, really, it doesn't do anything.
一些工具會自動獲取文件字串獲取物件的注釋,說明資訊。如需在**裡訪問文件字串,可以通過object.__doc__
屬性訪問。 python風格編碼 Python編碼風格 概述
對於 python 而言,pep 8 已成為大多數專案遵循的風格指南 它給出了乙個高度可讀,視覺友好的編碼風格。每個 python 開發者應該閱讀一下 這裡是為你提取出來的最重要的要點 from pymongo import mongoclient import gridfs,datetime,ti...
python 編碼風格
usr bin env python 在檔案頭部 第一行 加上 設定 python 直譯器 coding utf 8 在檔案頭部 第二行 加上 在編輯器中設定以 utf 8 預設編碼儲存檔案 docstring 是 python 特有的注釋風格,它是模 塊 類或函式的第乙個語句,可以通過 doc 方...
python編碼風格
usr bin env python 在檔案頭部 第一行 加上 設定 python 直譯器 coding utf 8 在檔案頭部 第二行 加上 在編輯器中設定以 utf 8 預設編碼儲存檔案使用中文字元,在檔案頭部加上 import sys reload sys sys.setdefaultenco...