Python類和方法注釋規(guī)范說明
更新時(shí)間：2022年06月10日 11:01:49 作者：XerCis
這篇文章主要介紹了Python類和方法注釋規(guī)范說明，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
Python類和方法注釋規(guī)范
注釋風(fēng)格
reStructuredText（PyCharm默認(rèn)）
def func(path, field_storage, temporary):
'''基本描述
詳細(xì)描述
:param path: The path of the file to wrap
:type path: str
:param field_storage: The :class:`FileStorage` instance to wrap
:type field_storage: FileStorage
:param temporary: Whether or not to delete the file when the File instance is destructed
:type temporary: bool
:returns: A buffered writable file descriptor
:rtype: BufferedFileStorage
'''
passdef func(path, field_storage, temporary):
'''基本描述
詳細(xì)描述
Parameters
----------
path : str
The path of the file to wrap
field_storage : FileStorage
The :class:`FileStorage` instance to wrap
temporary : bool
Whether or not to delete the file when the File instance is destructed
Returns
-------
BufferedFileStorage
A buffered writable file descriptor
'''
passGoogle（官方推薦）
def func(path, field_storage, temporary):
'''基本描述
詳細(xì)描述
Args:
path (str): The path of the file to wrap
field_storage (FileStorage): The :class:`FileStorage` instance to wrap
temporary (bool): Whether or not to delete the file when the File instance is destructed
Returns:
BufferedFileStorage: A buffered writable file descriptor
'''
pass| 風(fēng)格 | 特點(diǎn) | 適用 |
|---|---|---|
| reStructuredText | 用冒號(hào)分隔 | PyCharm默認(rèn) |
| NumPy | 用下劃線分隔 | 傾向垂直，長(zhǎng)而深的文檔 |
| 用縮進(jìn)分隔 | 傾向水平，短而簡(jiǎn)單的文檔 |
Sphinx對(duì)NumPy和Google風(fēng)格的對(duì)比，英文不好可以參考中文版
小技巧
在PyCharm中Ctrl+Q可快速查看注釋
代碼規(guī)范（含代碼注釋）
代碼縮進(jìn)和冒號(hào)
注意條件語句必須嚴(yán)格控制縮進(jìn)，保證父句和子句的關(guān)系
num = 10
if num>5:
? ? print('yes')
else:
? ? print('no')空行分隔代碼段
例如if語句判斷、while循環(huán)、for循環(huán)、def函數(shù)、class類等代碼段前后最好留一行（人工分好段落）
# if語句
if num>5:
? ? print('yes')
else:
? ? print('no')
?
# for循環(huán)
for i in (1,2,4):
? ? print(i)
?
# while循環(huán)
while i>3:
? ? print('yes')
? ? i+=1
else:
? ? print('end')
? ??
# 函數(shù)定義
def show():
? ? print(132)
?
# 類定義
class Person:
? ? def show(self):
? ? ? ? print(123)包、模塊的命名規(guī)范
1. 包——要求統(tǒng)一用小寫（相當(dāng)于文件夾）
2.模塊——要求統(tǒng)一用小寫（相當(dāng)于文件夾里的文件）
類和對(duì)象的命名規(guī)范
1. 類——嚴(yán)格的駝峰式寫法eg.IndexUserPerson
2. 對(duì)象——要求統(tǒng)一用小寫
函數(shù)的命名規(guī)范
駝峰式寫法 eg.indexUserPerson（不強(qiáng)行）
代碼注釋
1.單行注釋——#
2.多行注釋——（快捷鍵為Ctrl+/）
'''
三對(duì)單引號(hào)，python多行注釋符'''
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
在本篇文章里小編給大家整理的是一篇關(guān)于python re模塊常見用法例舉內(nèi)容，有興趣的朋友們可以學(xué)習(xí)下。2021-03-03
這篇文章的靈感來源于我玩游戲的時(shí)候，看見一個(gè)大佬在游戲里面建造了“還原方陣游戲”，就感覺很牛掰，就想著python不是有矩陣嗎，可以還原一下呢，感興趣的小伙伴可以了解一下2023-01-01
今天小編就為大家分享一篇Python之Class&Object用法詳解，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2019-12-12
Python中try excpet BaseException(異常處理捕獲)的使用
本文主要介紹了Python中try excpet BaseException(異常處理捕獲)的使用，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-03-03
今天小編就為大家分享一篇PyQt5多線程刷新界面防假死示例，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2019-12-12
這篇文章主要介紹了pytorch 使用半精度模型部署的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-05-05
Python實(shí)現(xiàn)網(wǎng)頁文件轉(zhuǎn)PDF文件和PNG圖片的示例代碼
這篇文章主要介紹了如何利用Python分別實(shí)現(xiàn)網(wǎng)頁文件轉(zhuǎn)為PDF文件和網(wǎng)頁文件轉(zhuǎn)PNG圖片的示例代碼，文中的代碼簡(jiǎn)潔易懂，感興趣的可以動(dòng)手試試2022-01-01
Django框架實(shí)現(xiàn)在線考試系統(tǒng)的示例代碼
這篇文章主要介紹了Django框架實(shí)現(xiàn)在線考試系統(tǒng)的示例代碼，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-11-11
Python?Fire中兩種命令行參數(shù)靈活設(shè)置方式詳解
Python的Fire庫,一個(gè)用來生成命令行工具的的庫,這篇文章主要針對(duì)命令行參數(shù),補(bǔ)充兩種更加靈活的設(shè)置方式,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2024-01-01
python 利用百度API識(shí)別圖片文字（多線程版）
這篇文章主要介紹了python 利用百度API識(shí)別圖片文字（多線程版），幫助大家更好的利用python進(jìn)行機(jī)器識(shí)別，感興趣的朋友可以了解下2020-12-12