程序員令人笑噴的代碼注釋,測試部:下班留下來談談!

PHP自學 / 2019-01-02 18:56:23

小編先說一件真事,以前在公司的時候,有一位技術非常牛逼的前輩,在代碼注釋中寫了“說了你也聽不懂!垃圾”,這不是重點,重點是他下意識的把這句話復制到了彈框提示的文字中,用來測試一個代碼的邏輯性,后來忘了刪除。代碼也提交到了測試部,巧的是在bug系統發現了這個bug,bug彈出了“說了你也聽不懂!垃圾”,最后被測試部的大佬邀請喝公辦茶。

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

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

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

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

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

3、涉及到業務邏輯的代碼,比如某些字段需要加說明,之類的。

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

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

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

4399小游戏上海麻将连连看 黑龙江快乐十分选号图查看 怎么样算出特肖 吉林时时预测软件下载 陕西快乐十分预测号码软件 四川时时快乐12 今天3d近十期奖号试机号 云南时时彩开奖 赛车pk10赚反水 博雅广东麻将下载手机版 湖北11遗漏