Python基礎(chǔ)第三講：這樣寫 Python 代碼注釋，方便你我他
注釋就是在你的代碼里面添加上解釋說(shuō)明。
代碼是告訴閱讀的人做什么事情，而注釋是告訴閱讀的人為什么這么做。
這點(diǎn)在學(xué)習(xí)編程的時(shí)候，特別重要；尤其在剛開始的時(shí)候一定要養(yǎng)成寫注釋的習(xí)慣，不要嫌其麻煩，因?yàn)樽⑨屨娴暮芊奖汩喿x代碼的人理解。
在實(shí)際工作中，項(xiàng)目一般都很大，需要協(xié)作完成。
如果有人沒寫注釋就給下一個(gè)人閱讀，那閱讀有可能變成特別痛苦的一件事情。有時(shí)候代碼漂不漂亮也要看注釋是不是全面。
不過(guò)目前的普遍狀況是，國(guó)內(nèi)很多人，即使是工作很多年的老程序員也不喜歡寫注釋。筆者在看國(guó)內(nèi)的 Python 或其它編程語(yǔ)言視頻教程時(shí)也發(fā)現(xiàn)很多老師不寫注釋。因?yàn)槁闊?，認(rèn)為是多干活。
這個(gè)觀點(diǎn)是錯(cuò)誤的，
因?yàn)榧词棺约簩懙拇a，2年以后我相信你自己都不記得寫的是什么了。
另外，據(jù)我了解，一些大公司代碼注釋寫的都非常全面，比如Google、 Oracle等。
既然注釋這么重要，咱們看看Python的注釋都有哪些呢？
01 單行注釋
在Python中，單行注釋用井號(hào)（#）標(biāo)識(shí)，也就是 # 后面的內(nèi)容；
但是，要注意以下幾點(diǎn):
A: # 和注釋內(nèi)容之間必須留一個(gè)空格才可以否則不符合規(guī)范， 如圖所示：
B: 注釋的作用是解釋說(shuō)明，并不是真的需要運(yùn)行。如下代碼。你只會(huì)看到你好，小碼哥，其他的你看不到。
C: 注釋可以寫在代碼的任何地方，甚至可以在代碼行中使用。推薦寫在代碼上面
D: 您寫的注釋一定要注意語(yǔ)言的簡(jiǎn)短、貼切、切中要害。PEP 8建議將代碼保持在79個(gè)字符或更少，代碼行中的注釋最多為72個(gè)字符。如果您的注釋接近或超過(guò)了該長(zhǎng)度，則需要將其轉(zhuǎn)變?yōu)槎嘈凶⑨尅?/span>
02 多行注釋
多行注釋用一對(duì)三引號(hào)（''' ''' ）或者一對(duì)三個(gè)雙引號(hào)(""" """)表示。
而多行注釋一般用在整個(gè)文本或者某一個(gè)代碼區(qū)域的解釋說(shuō)明，其中三個(gè)雙引號(hào)表示整個(gè)文檔的說(shuō)明。
有一點(diǎn)需要注意：雙引號(hào)是英文輸入法的，不是中文輸入法。今天有一個(gè)圈友遇到該問(wèn)題，他怎么無(wú)法注釋。希望大家注意。大家一起學(xué)習(xí)的效率還是比較高的，因?yàn)樗说膯?wèn)題就是自己的經(jīng)驗(yàn)，及早避免。
如果我們有很長(zhǎng)一段文字需要注釋呢？或者批量將代碼轉(zhuǎn)化為注釋，一行一行地注釋它可能需要很多時(shí)間！
在這種情況下，只需選擇需要作為注釋的代碼行并在PC上按Ctrl+/，或在Mac上按Cmd+/。所有選中的代碼前都將加上一個(gè)#標(biāo)記，并被程序忽略。
如果您的注釋行數(shù)較多，或者您正在閱讀的腳本中的注釋非常長(zhǎng)，那么您的文本編輯器可能會(huì)讓您選擇使用左側(cè) 減號(hào)(-)的折疊它們。如下圖
折疊前后對(duì)比
最后，需要注意一點(diǎn)：注釋雖然比較方便，但是并不是每一行代碼都需要注釋。只有關(guān)鍵的地方需要，比如：新的語(yǔ)法點(diǎn)、代碼重點(diǎn)解決的問(wèn)題、重要的細(xì)節(jié)或者結(jié)論等。
以上內(nèi)容摘自《零基礎(chǔ)輕松學(xué) Python》
更多精彩
在公眾號(hào)后臺(tái)對(duì)話框輸入以下關(guān)鍵詞
查看更多優(yōu)質(zhì)內(nèi)容！
PM2.5 | 世界杯 | 驚喜 | 附書代碼
覺得不錯(cuò)，請(qǐng)把這篇文章分享給你的朋友
轉(zhuǎn)載 / 投稿請(qǐng)聯(lián)系：data_circle_yoni
● 總結(jié) Python 的4張超大思維導(dǎo)圖，一定不要錯(cuò)過(guò)哦
● 知乎13萬(wàn)贊！為何很多名校畢業(yè)生，都輸在了人生后半程
● 【連載】小白輕松學(xué)Python ---- 到底如何入門 Python?
● 怎么才能自學(xué)成 Python 大牛？這有些建議
● Python打牢基礎(chǔ)，從22個(gè)語(yǔ)法開始！
● 手把手 | 爬取京東評(píng)論，且修改網(wǎng)址直接可復(fù)用哦(送代碼)
● 為何“Python 之父” 力薦的小藍(lán)書火了？
● Python實(shí)戰(zhàn) | 只需 ”三步“ 爬取二手iphone手機(jī)信息（轉(zhuǎn)發(fā)送源碼）