python代碼如何注釋
注釋
注釋就是對(duì)代碼的解釋和說(shuō)明。目的是為了讓別人和自己很容易看懂。為了讓別人一看就知道這段代碼是做什么用的。正確的程序注釋一般包括序言性注釋和功能性注釋。序言性注釋的主要內(nèi)容包括模塊的接口、數(shù)據(jù)的描述和模塊的功能。模塊的功能性注釋的主要內(nèi)容包括程序段的功能、語(yǔ)句的功能和數(shù)據(jù)的狀態(tài)。
注釋的分類
1.單行注釋
以#開(kāi)頭,#右邊的所有東西當(dāng)做說(shuō)明,而不是真正要執(zhí)行的程序,起輔助說(shuō)明作用
#我是注釋,可以在這里寫一下功能說(shuō)明之類
print("我上面一行是對(duì)我的注釋")
2.多行注釋
多行注釋是三對(duì)雙引號(hào)或者三對(duì)單引號(hào)都可以,對(duì),你沒(méi)有聽(tīng)錯(cuò)是三對(duì)啊,一個(gè)都不能少,而且是單引號(hào)和雙引號(hào)都可以,但是不要傻呼呼的一邊三個(gè)雙引號(hào),一邊三個(gè)單引號(hào),要單引號(hào)都單引號(hào),要雙引號(hào)都雙引號(hào)。
""" 我是多行注釋1 我是多行注釋2 我是多行注釋3 """ print("我上面的是多行注釋")
內(nèi)容補(bǔ)充:
以下實(shí)例我們可以輸出函數(shù)的注釋:
def a(): '''這是文檔字符串''' pass print(a.__doc__)
到此這篇關(guān)于python代碼如何注釋的文章就介紹到這了,更多相關(guān)python是如何注釋的內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
python sqlite3 判斷cursor的結(jié)果是否為空的案例
這篇文章主要介紹了python sqlite3 判斷cursor的結(jié)果是否為空的案例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2021-03-03解決在Python編輯器pycharm中程序run正常debug錯(cuò)誤的問(wèn)題
今天小編就為大家分享一篇解決在Python編輯器pycharm中程序run正常debug錯(cuò)誤的問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2019-01-01django restframework序列化字段校驗(yàn)規(guī)則
本文主要介紹了django restframework序列化字段校驗(yàn)規(guī)則,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-05-05Python深度學(xué)習(xí)實(shí)戰(zhàn)PyQt5菜單和工具欄功能作用
本文詳細(xì)解讀通過(guò) QtDesigner 創(chuàng)建主窗口、菜單欄和工具欄,并以菜單項(xiàng) “退出” 為例關(guān)聯(lián)系統(tǒng)定義的動(dòng)作處理方法。有需要的朋友可以借鑒參考下,希望能夠有所幫助2021-10-10Python識(shí)別html主要文本框過(guò)程解析
這篇文章主要介紹了python識(shí)別html主要文本框過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-02-02Python Pandas數(shù)據(jù)分析之iloc和loc的用法詳解
Pandas 是一個(gè)開(kāi)放源碼、BSD 許可的庫(kù),提供高性能、易于使用的數(shù)據(jù)結(jié)構(gòu)和數(shù)據(jù)分析工具,它是一個(gè)強(qiáng)大的分析結(jié)構(gòu)化數(shù)據(jù)的工具集,基礎(chǔ)是 Numpy2021-11-11Python使用gRPC實(shí)現(xiàn)數(shù)據(jù)分析能力的共享
gRPC是一個(gè)高性能、開(kāi)源、通用的遠(yuǎn)程過(guò)程調(diào)用(RPC)框架,由Google推出,本文主要介紹了Python如何使用gRPC實(shí)現(xiàn)數(shù)據(jù)分析能力的共享,感興趣的可以了解下2024-02-02python去重,一個(gè)由dict組成的list的去重示例
今天小編就為大家分享一篇python去重,一個(gè)由dict組成的list的去重示例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2019-01-01