python注釋規範 動態注釋和靜態注釋

2021-09-10 10:17:32 字數 1962 閱讀 2599

對python進行注釋可以提高**的規範,也能提高效率。這其中包括對函式、類等之間的快速的注釋,另一方面包括對注釋內容的規範書寫。

python主要包括兩部分:

一、是單行和多行的注釋;

二、是**的注釋規則;

一、python單行注釋符號(#)

其中"#"右邊的內容不會輸出,用於對單行注釋。

使用的快捷鍵是:ctrl + 』/『

二、批量、多行注釋符號

在python中也會有注釋有很多行的時候,這種情況下就需要批量多行注釋符了。多行注釋是用三引號包含的,例如:

使用方法:敲三個單引號或者雙引號,回車即可出現如圖中所示。

**注釋規則中分為靜態注釋和動態注釋。

一、靜態注釋-單行

單行中除了可以使用』#『來對單行進行注釋,也可以用如下圖所示,來對返回的型別進行限制。

需要注意的是:使用# type:的方式,如果在不知道返回型別的情況下,也可以自動補全**,但是並不會檢查語法或者**邏輯上的錯誤。

二、靜態注釋-多行多行中的引數都有各自的意義,不同的變數代表著不同的功能,一般預設生成的為冒號加引數的形式 」:param「 在如下所示中,展示了各種不同的引數。

三、動態注釋

動態注釋僅限與python的3.多的版本。表現形式為:

def 函式名 -> 注釋內容

注釋內容一般用於包括 對引數的型別的表示,多個引數用小括號,注釋內容用單引號或者雙引號,具體各類如下所示:

1.單個引數

型別方式:

def 函式名(引數)->型別:

的方式,型別表示函式返回的引數型別。

2.多個引數

型別方式:

def 函式名(引數1,引數2,…)-> (引數1型別,引數2型別,…):

此時的注釋是對函式的引數的型別的定義

或者如下

def 函式名(引數1,引數2,…)-> (引數1型別,引數2型別,…):->返回型別

3.注釋內容

對靜態注釋中的型別引數,例如:冒號加 引數type:type等引數還不是很了解,以後再逐步使用過程中會對部落格不斷加強補充。

python的注釋規範

pydoc是python自帶的乙個文件生成工具,使用pydoc可以很方便的檢視類和方法結構 命令 python3 m pydoc p 1234 通過http localhost 1234來訪問檢視文件 說明 1 p指定啟動的服務的埠號,可以隨意指定不衝突的埠號 2 只有在自建的工程根目錄下使用該命令...

C 注釋規範

5.注釋 5.1.注釋的基本約定 注釋應該增加 的清晰度 保持注釋的簡潔,不是任何 都需要注釋的,過多的注釋反而會影響 的可讀性。注釋不要包括其他的特殊字元。建議先寫注釋,後寫 注釋和 一起完成 如果語句塊 比如迴圈和條件分枝的 塊 太長,巢狀太多,則在其結束 要加上注釋,標誌對應的開始語句。如果分...

c 注釋規範

模組開始必須以以下格式編寫模組注釋 模組編號 模組編號,可以引用系統設計中的模組編號 作用 對此類的描述,可以引用系統設計中的描述 編寫日期 模組建立日期,格式 yyyy mm dd 如果模組有修改,則每次修改必須新增以下注釋 log編號 修改描述 對此修改的描述 修改日期 模組修改日期 格式 yy...