Python自學教程2:大牛們怎麼寫註釋

在還沒開始學代碼前,就要先學會寫註釋。不會寫註釋的程序員會遭到鄙視和唾棄,甚至在工作中會被人穿小鞋。註釋也不是隨便寫一下就行,用好註釋還是有點講究的。

註釋有什麼用?

註釋(Comments)主要是向閱讀代碼的人解釋某些代碼的作用和功能,它可以出現在代碼中的任何位置。Python 在執行代碼時會忽略註釋,不做任何處理,就好像它不存在一樣。註釋主要是給人看的,而不是給機器運行的。

舉個例子。你寫了一段非常厲害的代碼,可以讓汽車自動駕駛的代碼,但是這段代碼用了很多複雜的算法,別的人很難看懂,所以你就會在這一段代碼中添加註釋,解釋下代碼的意思。 這樣,就算別人一時間很難理解代碼,也可以通過讀註釋知道代碼做了什麼事情。

一般我們會使用 # 號來表示註釋,並且在代碼上方寫註釋來說明代碼的作用。

# 這段代碼實現了自動駕駛功能

# 使用 CNN 算法實現...
do_something_cnn

# 使用傅里葉轉換
do_something

註釋的最大作用是提高程序的可讀性,沒有註釋的程序對別人來說簡直就是噩夢。 我們寫完代碼以後,可能會有代碼審查,如果很難理解,公司可能會打回來,讓你重新補齊註釋。

還有一種情況,當你半個月以後再來看之前寫的代碼,可能根本想不起來爲什麼這麼寫。有了註釋,可以迅速幫你回想之前的實現細節。很多程序員寧願自己去開發一個應用,也不願意去修改別人的代碼,沒有合理的註釋是一個重要的原因。

千萬不要認爲你自己寫的代碼規範就可以不加註釋,這樣很容易引起同事之間的相互嫌棄。

註釋的表示方法

第一種方式是使用# 號,也就是上面的用法,它只能用來表示某一行是註釋,不能表示多行, 如果同時有幾行都是註釋,就需要每一行前面都添加一個 # 號。

# 第一行註釋
# 第二行註釋
# 第三行註釋
do_something_with_code

另一種方式是使用三引號 """""" ,這種方式可以非常方便的寫多行註釋,比較常用在註釋比較長的的地方。

"""這段註釋比較長。

因爲比較長,所以我們用的是三個引號,
不管怎麼換行,都會比較方便。
"""
do_something_with_code

快捷鍵

當表示註釋時,每次都要在前面加上一個# 號是不方便的,所以經常會使用快捷鍵來表示註釋,每個編輯器的快捷鍵會稍微有一點區別,以 Pycharm 爲例,當需要表示註釋時,我們把要註釋的代碼用鼠標選中,然後使用 ctrl + / 快捷鍵就可以自動在前面加上 # 號, 如果有多行,選中多行就可以了。

快捷鍵表示註釋經常用在我們寫了一些代碼,結果暫時不想讓這些代碼運行,就可以使用快捷鍵,把這些代碼迅速轉成註釋。後面想用的的時候再選中這些註釋,再按一下快捷鍵,就又會轉回代碼。

comments.gif
comments.gif

大牛們的註釋習慣

在我接觸到的技術大牛中,都有一套自己的註釋習慣,雖然每個人會稍微有點區別,但是大體上都差不多。現在都還沒說開始寫代碼呢就學大牛,好像有點早,但我以爲好的註釋習慣能快速提高寫代碼的速度。

那麼,一套好的註釋習慣會包含哪些要素呢?

要素一:用註釋在每個自己創建的文件上說明作者、聯繫方式、創建時間, 這樣如果別人看到這段代碼有什麼疑問,可以第一時間聯繫你。

# -----------------------------------------------
# Author: 九柄
# 微信號: jiubing1
# 公衆號: 九柄
# -----------------------------------------------

在 Pycharm 當中,你並不需要每創建一個文件都手動輸入這些註釋,可以通過模板創建的方式自動添加。有了模板以後,每創建一個新文件,pycharm 會自動帶上這些註釋信息。

在 Pycharm中點擊 File→Settings→Editor→File and code Templates,右側找到Python Script,如下圖。 時間這種會變的直接用花括號括起來,不會變的就直接寫。

要素二: 在文件的頂部說明一下這個文件的具體功能,在這裏可以說明一下這個文件的具體用法,甚至可以舉一些例子,別人可以照着操作。

"""數據操作模塊。

主要是對數據庫操作的封裝,包括查詢數據,插入數據,更新數據。
具體用法如下:
...
"""

要素三: 在每個函數的下面用多行註釋寫下函數的作用。

class DAO:    
    def insert_rows(self, table_name,data_set):
    	"""把excel文件數據導入數據庫"""
    	pass

要素四:單行註釋要適量,太多單行註釋反而會影響別人閱讀代碼。想象一下,你的代碼本來就寫得不錯,也容易理解,但是偏要寫一行代碼就說明一下什麼意思,那就有點畫蛇添足了。 所以單行註釋只在特別難理解的代碼上適度添加就行了,不需要每行代碼都說明一下。

# 特別難懂的代碼再寫註釋
do_something_difficultly()

總結

註釋是學一門編程語言最簡單的語法,實際上,這一片只講了 # 號和 """""" 三引號這兩個特別簡單的語法。但是真要用起來,光會語法是不夠的,編程總是要帶入到具體的工作中, 如果沒有具體的使用場景,學再多的語法是沒什麼用的。

我還準備了很多學習技巧和麪試套路,基本都可以在文本名片 九柄 獲取,順便三連哦。 image.png

很多自學 Python 的人,看了很多教程,但最終還是不會用,不敢用,其中的原因就是沒有根據實用性學習,總以爲知識學得越多越好。 實際上,很多語法根本就沒必要學,因爲你這輩子都用不到,而像註釋這樣的語法,雖然很簡單,但是要用好,也不一定容易。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章