1. 程式人生 > >那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

真事兒,在公司的時候,曾經有一位技術很牛的前輩,在程式碼中的註釋上寫了一句“測個毛”,這不是重點,重點是他把這句話粘到了彈出框的文字上,自己測試一下程式碼邏輯,就隨意打了這三個字,結果提交程式碼忘記修改了,後來在bug系統發現了這個bug,並得到了測試部老大的問候。

如果有想學習java的程式設計師,可以來我們的java學習群:8184,64711免費送java的視訊教程噢!小編是一名5年java開發經驗的全棧工程師,整理了一份適合18年學習的java乾貨,送給每一位想學的小夥伴,歡迎大家一起學習哦。

那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

那些令人噴飯的程式碼註釋,最後一個讓我笑出了聲!

個人觀點,只是經驗之談,歡迎來噴 !

1、在類級別,方法級別上最好加上註釋。

特別是那些邏輯複雜的,難以用一句話描述清楚的內容,最好加上註釋,講清楚這個類,或這個方法是用來幹嘛的,有什麼需要注意的地方。這個註釋很重要,特別是這些程式碼還要被其他人使用的時候,加上說明會方便很多。

2、在某些容易留坑的地方,最好加上註釋。

這種地方很多時候是因為圖省事,或者沒時間等原因,只能暫時這麼做,但是需要提醒使用者注意。或者懷疑隊友水平沒那麼高,理解不了你的程式碼,某天來修改程式碼並且容易改錯。或者是因為這段程式碼『特立獨行』,不是按照常規方式,你自己在這裡耍了小聰明,或者用了自己設計的一些技巧性的東西,怕別人看不懂。

3、涉及到業務邏輯的程式碼,比如某些欄位需要加說明,之類的。

有些業務的東西,確實不是一兩句程式碼就能扯清楚的,這種東西,加個註釋就好了。

4、因為修復某個bug而加進去的程式碼。

改bug,特別是改別人的bug的時候,如果不是進行大規模的重構,而是往裡面加小段程式碼打補丁的時候,最好加上註釋,否則這段程式碼很奇怪,並且容易看不懂。記住最好留上你的名字,不然後人看這個程式碼都不知道該去罵誰,hiahiahia~。