真事兒,在公司的時候材部,曾經(jīng)有一位技術(shù)很牛的前輩毫缆,在代碼中的注釋上寫了一句“測個毛”,這不是重點乐导,重點是他把這句話粘到了彈出框的文字上苦丁,自己測試一下代碼邏輯,就隨意打了這三個字物臂,結(jié)果提交代碼忘記修改了旺拉,后來在bug系統(tǒng)發(fā)現(xiàn)了這個bug,并得到了測試部老大的問候棵磷。
如果有想學習java的程序員蛾狗,可以來我們的java學習群:8184,64711免費送java的視頻教程噢仪媒!小編是一名5年java開發(fā)經(jīng)驗的全棧工程師沉桌,整理了一份適合18年學習的java干貨,送給每一位想學的小伙伴,歡迎大家一起學習哦蒲牧。
個人觀點撇贺,只是經(jīng)驗之談,歡迎來噴 冰抢!
1松嘶、在類級別,方法級別上最好加上注釋挎扰。
特別是那些邏輯復雜的翠订,難以用一句話描述清楚的內(nèi)容,最好加上注釋遵倦,講清楚這個類尽超,或這個方法是用來干嘛的,有什么需要注意的地方梧躺。這個注釋很重要似谁,特別是這些代碼還要被其他人使用的時候,加上說明會方便很多掠哥。
2巩踏、在某些容易留坑的地方,最好加上注釋续搀。
這種地方很多時候是因為圖省事塞琼,或者沒時間等原因,只能暫時這么做禁舷,但是需要提醒使用者注意彪杉。或者懷疑隊友水平?jīng)]那么高牵咙,理解不了你的代碼派近,某天來修改代碼并且容易改錯∷螅或者是因為這段代碼『特立獨行』构哺,不是按照常規(guī)方式,你自己在這里耍了小聰明战坤,或者用了自己設計的一些技巧性的東西,怕別人看不懂残拐。
3途茫、涉及到業(yè)務邏輯的代碼,比如某些字段需要加說明溪食,之類的囊卜。
有些業(yè)務的東西,確實不是一兩句代碼就能扯清楚的,這種東西栅组,加個注釋就好了雀瓢。
4、因為修復某個bug而加進去的代碼玉掸。
改bug刃麸,特別是改別人的bug的時候,如果不是進行大規(guī)模的重構(gòu)司浪,而是往里面加小段代碼打補丁的時候泊业,最好加上注釋,否則這段代碼很奇怪啊易,并且容易看不懂吁伺。記住最好留上你的名字,不然后人看這個代碼都不知道該去罵誰租谈,hiahiahia~篮奄。