註釋就是輔助自己過一段時間或者接手的人理解你寫的程式程式碼的手段，良好的註釋體驗出你邏輯思路清晰。

如果沒有註釋，不僅一段時間之後自己可能無法理解當時為何自己這樣寫，維護的人也會一篇茫然不知所措。

說什麼都難免蒼白無力，直接的體會就是: 假設你接手了前任的沒有任何註釋的專案時，你立馬就會體會到程式有(好的)註釋是多麼得重要，看著這樣的程式碼連平日裡斯文的你嘴邊都不時會湧現出問候程式作者本人或其祖先的話來，原因就是半天看不懂是什麼意思！

更難以置信的是有些自已寫的程式碼幾個月之後竟然也一時半會兒看不懂是什麼意思！

現在程式設計師可是說是滿地都是，層次不同寫出的程式碼風格也完全不一樣，程式碼就像一片文章，有些人寫的程式規章有度，則有些程式設計師寫出來的則是東一下西一下，雖然也能執行可是各位考慮過嗎如果你辭職之後你的程式碼需要改進 ，看到你的程式碼一臉懵逼，他甚至會罵寫這些程式碼的人，他會說你寫的都是BUG，在需求隨時變更的時代作為一名程式設計師應該做到，寫好備註不然寫完了你從頭檢查的時候你會發現你居然不知道你寫的是個什麼鬼，還有就是千萬要讀懂需求再去寫程式碼，程式設計師不是一個著急的人能的行業，膽大心細願意去嘗試，不寫程式碼註釋你會發現以後苦逼維護的還是你，註釋就像你兒子身上的胎記，如果沒有這個胎記你就發現過了五六年你連你孩子都不認識了

    還有就是做專案要多交流，有個良好的環境，不然低頭做做完了之後你會發現你理解錯了需求，客戶就是你的金主爸爸，及時與團隊溝通才能達到準確的知道客戶需求與專案進度，做程式設計師不能一枝獨秀，特別是在一個團隊，團隊和諧才有更好的氛圍。

程式註釋要堅持less is more的原則。

你的寫的程式碼不是註釋越多越好，首先你將你的邏輯理清楚，好的邏輯性會減少很多註釋，差的邏輯程式碼，你會發現無從註釋，不知道怎麼描述。不能忘記註釋本身的作用，程式設計kpi形式註釋。

一般註釋對於引數 ，介面，方法一定要加註釋，因為畢竟母語不是英語不是母語，很多時候用詞不準確，造成後面理解和閱讀困難。

方法內部儘量少註釋，除非這段邏輯寫的很精剪，需要描述。儘量讓程式碼自描述完整，邏輯一幕瞭然，其次在方法內部可能存在多個邏輯段。不同邏輯段需要註釋一下。方便閱讀。

程式註釋非常重要！！！好的程式碼首先要易於閱讀，其次才是效率。

1. 程式碼是持續性的工作，後期需要不斷在現有程式碼上進行調整和最佳化。自己剛寫的程式碼對邏輯和含義會比較清楚，但是隨著時間流逝，自己也會忘記，如果這時讓你來修改這段程式碼你需要花很多精力去回憶和讀懂原來寫的邏輯。

2. 程式碼是團隊資產，會有多人一起進行維護和編輯。如果不寫註釋，其他人看起來會非常費勁。工作中經常會發生這種情況，某員工離職了，別人接手他的程式碼，但是沒有註釋看不懂，導致不敢輕易去修改，乾脆自己重新寫一套了，這樣對公司來說是極大的資源浪費。

3. 寫程式碼註釋是程式設計師的必備素質，不願意註釋可能是因為懶，也可能是為了趕工想著後面再來補。不管是哪種原因，這都是不好的習慣。我在面試程式設計師是都會問他們寫註釋的方法，可以按功能，可以按函式，也可以按程式碼難點等等。其實寫註釋可以按自己的習慣，只要清楚明白，讓別人能看懂即可。

看看大神們寫的程式碼，幾乎每行都有註釋

程式語言的種類不可勝舉，以後肯定還會有新的語言出來，但是不論是哪種程式語言都會大篇幅來講註釋的寫法，可見重要性。

用適合自己的方法來寫註釋。養成自己的程式設計技巧，對自身發展也很重要。

總之，程式註釋非常重要！！！

就是提高了可維護性，分為兩方面:

1.讓別人能看懂，便於業務對接。因為你不可能一個人幹所有活，太多了。

2.讓自己看懂，程式碼寫多了，有很多類似，不註釋會雜亂，找不到，而且時間一長自己也忘了邏輯，出錯了就不能及時修改。修改的時候直接搜尋註釋，一下就能找到相應地方，而且也能讓自己快速知道當時寫了什麼。

有這樣一句話“最好的註釋就是程式碼本身”。

其意思就是好的程式碼能夠讓讀者比較容易理解其功能、邏輯等。

那麼程式註釋的目的也在於此。

對外提供的API需要註釋清楚 介面的作用及傳入的引數要求等；但是程式碼也不是註釋越多越好，寫的好的程式碼注意程式碼的可讀性及邏輯性都很清晰！註釋遵循短小精悍

說起程式註釋重要性。我想起一個笑話，一個福建人離職了，另一個人來接替，然後那個人看程式，是關於稅務互動的。其中一個經常出現的變數名為zaisui，沒有註釋，那人猜了半天不明白什麼意思。後來終於聯絡到那個福建人為財稅，據說當時有想要掐死他的衝動。我就問你，註釋到底重不重要。

程式註釋很重要，沒有註釋，程式在後序很難維護。

1，要註明開發及維護日期，姓名。這主要是找bug用。人的記憶力是有限的，也是有時效的。把幾年前，或者更短一些，幾個月前寫的軟體，讓你再看，估計也有些迷糊了。所以，相關維護記錄應很清楚。