最近參加了一個比賽，然後看到隊友編程的代碼，我覺得真的是難以下咽，幾乎每個字符都要咨詢他，用老師的話來說，這就是山炮編程員，所以此時的我意識到寫一篇關於註釋程序的重要性了，因此特地的寫一篇文章幫助大家入門。

註釋不止是為了自己以後看的更清楚，還是為了以後的開發人員所準備的，其實一段時間後，當需要對程序做一些修改或者是改正某個bug的時候，可能未來的我們自己都會忘記相關的細節，所以此時註釋顯得尤為重要。

每條註釋以井號（#）開始，一直到該行末尾結束，一直到該行末尾結束。我們可以在註釋中放任何東西，因為Python 會完全無視他們的存在。為了寫好註釋，這裏給出以後幾條規則：

（1） 假設讀者的Python 水平和你一樣（比如說，不要去解釋 “ 什麽是字符串 ” ， 也不要去解釋 “ 什麽是賦值語句 ”）

（2） 不要去註釋那些毫無意義的事情。比如說：

count = count +1   # add one  to count

( 3） 很多程序員會在代碼上寫上一些以 “ TODO ” 或者 “ FIXME ”開始的註釋，目的就是為了提醒他們回來編寫或清理一些未完成的一些問題。

（4） 如果你在編寫某段程序的時候需要使勁思考的話，應該編寫註釋，以後別人不會在這個地方絞盡腦汁。尤其要註意的是，如果你在開發程序的時候或者函數編寫的時候使用要點來描述，盡量寫的細致一點，在開發工作完成之後，還應該將原來的要點全部保留下倆直接做解釋。

（5） 同樣，如果某個bug很難查明，或者其修改方案比較復雜，那麽你就應該編寫一條註釋對其進行解釋。如果不這麽做，那麽今後其他復雜該部分的代碼的程序員就會可能認定他們沒有必要這麽復雜並將其改為原來的樣子，從而將你的心血付諸東流。

（6）如果需要大量的註釋才能解釋清楚某段代碼的作用，那麽就應該對這些代碼進行整理，比如，如果需要分別對一個函數的15個列表進行解釋，那麽就應該將該函數拆分成更小的代碼塊，每隔分別只處理較小的幾個列表。

（7） 過時的註釋還不如沒有註釋，因此修改某段代碼後，一定要檢查相關註釋，並對其做出適當的修改以保證其仍然能夠準確描述代碼的功能。

（8） 註釋不是越多越好，弄得整篇代碼都是註釋，卻很少看到代碼，這樣就曲解了註釋的意思了。

所以說，一定要養成良好的註釋代碼的習慣，邊寫代碼邊註釋，及時的記錄下來你的思路，舉個例子，代碼是魚，註釋就是水，有了正確的註釋，魚才能更好的生存。還有就是多提高自己對代碼的解釋能力，用精煉的語言表達出代碼的核心價值所在，那麽你寫的代碼就是成功的。

下面舉個例子

def find_two_smallest(L):
    ‘‘‘Return a tuple of the indices of the two smallest values in list L‘‘‘
    smallest = min(L)
    min1 = L.index(smallest)
    L.remove(smallest)
    next_smallest = min(L)
    min2 = L.index(next_smallest)
    L.insert(min1,smallest)
    if min1<=min2:
        min2+=1
    return(min1,min2)

Python 淺談註釋的重要性