java碼農:我寫代碼會加註釋但不會寫作者名,這其中是有原因的!

程序員 Java 集成開發環境 Git 上世是朵花 2019-05-19

對於編程來說,特別是一些業務開發,寫代碼與寫註釋是一樣重要的,如果時間緊可以暫時不寫文檔或者後補,但是代碼註釋是必須要有的,代碼的註釋對代碼的維護起著至關重要的作用,即便如此好多程序員在寫代碼註釋上還是過於敷衍或者說潦草,都認為是自己寫的代碼,有什麼看不懂的,雖是這麼想的,但是時間久了,再回來看自己的代碼,還真有點費勁,我想部分程序員是有這種體會的吧,既然自己就是這樣,那對於其他人來說,來看自己的代碼就更困難了,因此寫代碼不寫註釋不是一種好習慣,關於寫註釋的事,有一名程序員網友給我們分享了他的一個特點。

java碼農:我寫代碼會加註釋但不會寫作者名,這其中是有原因的!

據這名程序員網友說,他寫代碼,從來不留@author註解,但是普通註釋他還是會加的,之所以這麼做,他賣萌似的說了一句,如果代碼有問題,要想揪出我,只能通過Git日誌,不給他們提供那麼便利的條件,呵呵,這麼說看來對自己寫的代碼還是不夠自信了啊,為什麼總是想著會有問題呢,與他相反,我之前遇到的一位程序員是註釋不註釋的不在乎,只要寫代碼先把作者名稱給掛上,甚至有的時候從網上覆制別人的代碼,他也會把作者名稱改成自己的,他的理由是這是工作量證明啊,自己寫的東西肯定要標記自己的名字呀,看來他們看問題的角度還是真的挺不一樣,針對這些情況,讓我們一起看看其他網友們都是怎麼看待的吧!

java碼農:我寫代碼會加註釋但不會寫作者名,這其中是有原因的!

網友一:這是一個好習慣

上世是朵花:看來這名網友平時也是同樣的想法或者是採取相同的做法嘍。

網友二:Author沒啥用。​只是個初始版本

上世是朵花:沒錯,Author只是初建者人的名字,中間還有可能經過多人修改這段代碼。

網友三:jetbrains全家桶右鍵顯示註解,誰的鍋一目瞭然

上世是朵花:工具只是輔助作用吧,其實最實質的,最精確可靠的是看提交日誌了。

網友四:又不是寫了author就都是這個人改的,被人改出問題太常見了

上世是朵花:是的,這名網友在這方面可見很有體會,有相當一部分情況是,你寫的代碼可能是其他人也在修改。

java碼農:我寫代碼會加註釋但不會寫作者名,這其中是有原因的!

網友五:寫這沒用,代碼可能被別人改,寫了會背鍋

上世是朵花:我想遇到嚴重的問題不可能只是看作者名稱這麼簡單吧,也肯定會追得更細一點吧,有的程序員已經離職2年了,這之後再出什麼問題肯定不關他的事了,雖然代碼的作者還標的是他的名字。

網友六:歸根結底,還是對自己代碼質量沒信心

上世是朵花:有點這個意思吧,算是不夠自信的表現。

java碼農:我寫代碼會加註釋但不會寫作者名,這其中是有原因的!

其實,關於註釋的作者名稱只是表明代碼這段代碼的初創人是誰,由誰發起的而已,在實際情況中,大家都知道,一些代碼可能是由多個人來維護的,雖然作者的名字是不變的,如果這段代碼出問題就去找標有作者名稱的人,相信好多程序員是比較冤枉的,另外大家都知道,現在的IDE工具寫註釋非常方便,就以java代碼為例,你通過IDE創建一個類,一些方法 類get,set方法以及註釋,作者等信息在事先設置的規則下就自動生成了,註釋的作者都是可以輕鬆編輯的,既然能輕鬆編輯,那麼絕對不是通過這個東西進行定責的,這樣的做法顯然是不靠譜的,標記作者只是信息展示的一部分,不過我個人覺得還是標上自己的名稱吧,起碼能讓人看出來這些代碼是由你主導來寫的,起碼也能體現你的工作量不是麼?如果寫了很多代碼,以後不在公司了,後來的程序員還能在代碼中知道你的名字,這也不是挺好的嗎?

以上所有圖片均來之互聯網

大家好,我是“上世是朵花”。如果你有什麼好的看法或者觀點可以在評論區展現你的才華,互動交流,如果想進一步瞭解我,那就關注我吧!

相關推薦

推薦中...