真事兒,在公司的時候鲤嫡,曾經有一位技術很牛的前輩送挑,在代碼中的注釋上寫了一句“測個毛”,這不是重點暖眼,重點是他把這句話粘到了彈出框的文字上惕耕,自己測試一下代碼邏輯,就隨意打了這三個字诫肠,結果提交代碼忘記修改了司澎,后來在bug系統(tǒng)發(fā)現(xiàn)了這個bug,并得到了測試部老大的問候栋豫。
個人觀點挤安,只是經驗之談,歡迎來噴 丧鸯!
1蛤铜、在類級別,方法級別上最好加上注釋丛肢。
特別是那些邏輯復雜的围肥,難以用一句話描述清楚的內容,最好加上注釋摔踱,講清楚這個類虐先,或這個方法是用來干嘛的,有什么需要注意的地方派敷。這個注釋很重要蛹批,特別是這些代碼還要被其他人使用的時候,加上說明會方便很多篮愉。
2腐芍、在某些容易留坑的地方,最好加上注釋试躏。
這種地方很多時候是因為圖省事猪勇,或者沒時間等原因,只能暫時這么做颠蕴,但是需要提醒使用者注意泣刹≈觯或者懷疑隊友水平沒那么高,理解不了你的代碼椅您,某天來修改代碼并且容易改錯外冀。或者是因為這段代碼『特立獨行』掀泳,不是按照常規(guī)方式雪隧,你自己在這里耍了小聰明,或者用了自己設計的一些技巧性的東西员舵,怕別人看不懂脑沿。
3、涉及到業(yè)務邏輯的代碼马僻,比如某些字段需要加說明庄拇,之類的。
有些業(yè)務的東西巫玻,確實不是一兩句代碼就能扯清楚的丛忆,這種東西祠汇,加個注釋就好了仍秤。
4、因為修復某個bug而加進去的代碼可很。
改bug诗力,特別是改別人的bug的時候,如果不是進行大規(guī)模的重構我抠,而是往里面加小段代碼打補丁的時候苇本,最好加上注釋,否則這段代碼很奇怪菜拓,并且容易看不懂瓣窄。記住最好留上你的名字,不然后人看這個代碼都不知道該去罵誰纳鼎,hiahiahia~俺夕。
軟件開發(fā)學習之路http://www.zparkedu.com/