1. 程式人生 > >程式設計師為什麼不寫註釋

程式設計師為什麼不寫註釋

記得剛參加工作,經理就給組裡的人發了一份他寫的專案程式碼,當時面對這樣一個大專案,看了幾天,組裡的人都抱怨程式碼沒有註釋,難讀。這是經理就說了句話,我記到了現在: “你們老是抱怨別人的程式碼沒有註釋,可是你們有給自己的程式碼寫註釋嗎?” 的確如此,我們希望看到別人的註釋,同時又不想給自己的程式碼寫註釋。對於那些開源大型專案,一般會有良好的註釋,團隊本身也非常優秀,管理規範,專案擁有大量的使用者,這類專案一般不會缺少註釋,是否自願的就不一定了。 想必都讀過程式碼的人都有體會,在自己水平範圍內,實現某個功能和看懂別人的實現程式碼,後者的難度往往大於前者。儘管很多人說好程式碼不需要註釋,本身就是“自注釋”。但是你會發現,說這種話的人,要麼是大牛,要麼是菜鳥。就身邊的觀察而已,當讀別人的程式碼時,是希望有必要的註釋的。 大多數公司裡,接手別人的程式碼,是缺乏必要的註釋的。github上的個人Repositories是普遍缺乏註釋的。他們為什麼不寫註釋?
因為寫註釋是利他行為。 特別是公司專案,接手程式碼的是同職位的人,互為競爭。因此,即使公司規範中要求寫註釋,你也明明知道,以後會有人接手你的專案,可是你很少會為後人寫註釋。我接手過10個專案,只有一個專案是有少許註釋的。 帶有註釋的程式碼已成為一種奢望。如果你是專案組長,與其勉強同事們寫上註釋,不如提倡Coding Without Comments。當不提倡寫註釋時,他們會更用心地寫好變數名,函式名。不得不承認,註釋雖好,寫好卻難。比如維護困難,當實現修改後,註釋經常忘記同步。有的註釋是模糊的,多餘的。時間久遠後,誰也搞不懂這段註釋是什麼意思了。可見,即使要寫註釋,儘量是簡明扼要。 寫好註釋跟寫好程式碼一樣,是藝術活。 (2016/4/1)

相關推薦

程式設計師為什麼註釋

記得剛參加工作,經理就給組裡的人發了一份他寫的專案程式碼,當時面對這樣一個大專案,看了幾天,組裡的人都抱怨程式碼沒有註釋,難讀。這是經理就說了句話,我記到了現在: “你們老是抱怨別人的程式碼沒有註釋,可是你們有給自己的程式碼寫註釋嗎?” 的確如此,我們希望看到別人的註

優秀的程式設計師真的註釋嗎?

我在很多地方看到這樣一個觀點,“請停止寫註釋,因為只有爛的程式碼才需要註釋。”這個觀點非常巧妙,它讓我想起了孟子的一句話,“楊氏為我,是無君也;墨氏兼愛,是無父也。無父無君,是禽獸也。” 動不動就罵別人是“禽獸”,我總覺得有點不妥,這很不符合孟子的浩然之氣啊。有些大牛也有孟子這樣的覺悟,如果有人要他給自己

程式設計師好好報告的結果是很嚴重的

轉自:http://blog.sciencenet.cn/blog-404304-884328.html 倒騰了很久的程式碼,結果測試也通過了,然後現在要寫報告了,心情的表情馬上從呲牙變成咧嘴。 倒騰了一上午,一直在摸索怎樣在linux平臺上把報告怎麼快速搞出來,然而

.NET程式設計師加班——在《華為工程師猝死,36歲,22月無休》之後

我首先承認,有點標題黨。因為這是我這個十年老碼農——過了年就整整11年了,o(╥﹏╥)o——的個人觀察、經驗所得。如果有仍在加班的.NET童鞋,不要打我。一定要打的話,只有一個要求:不要打臉! 寫這篇部落格是因為這篇報道:華為工程師猝死,36歲,22月無休:比掙錢更重要的是活著。作為一個37歲邊緣,馬上就要

為什麼很多程式設計師喜歡單元測試?

業界良心。。。。 我認為這和懶惰與否沒有關係,測試不是必須要寫的,有人說:僱主不是為測試而付錢給我的(大意),這話的意思是如果客觀條件不允許(比如時間緊張)或者沒必要(比如目的碼你閉著眼睛都能寫得很好)等情況下,測試不寫也就不寫了,沒什麼大不了。 如果你覺得自己

指令碼熟練的程式設計師是好程式設計師----小話python(1)

作者:陳曦 日期:2012-6-30 11:18:06  環境:[Mac 10.7.1 Lion Intel-based i3,支援64位指令  Python 2.7.1  gcc4.2.1]  轉載請註明出處 Q1: 指令碼的本質是什麼? A: 它就是一段程式碼,只不過

程式設計師能只會程式碼

大多數程式設計師給人的印象都是:一整天忙忙碌碌的在寫程式碼,改bug,或者開會討論,還有一大部分在瀏覽各種網站(不管是瀏覽技術部落格,新聞,還是自己感興趣的東西),即時通訊聊天。不管是什麼狀態,總應該有點結果和收穫。很多時候剛進入一家企業或者剛開始一個專案時,總

一道簡單的面試題:竟然有90%的程式設計師能把這個演算法完全正確。。。

前段時間,在論壇上看到有統計說有90%的程式設計師不能夠寫對簡單的二分法。二分法不是很簡單的嗎? 這難道不是聳人聽聞? 其實,

誰說程式設計師是潛力股?讓這位世界前五名的天才程式設計師來顛覆你三觀!

  作為一名程式設計師,我想很多朋友都會抱怨,沒時間交友娛樂,沒時間找女朋友,更沒時間打扮自己,於是每天穿著一件不知道從哪裡翻出來的T恤坐在電腦面前,“忙碌”的工作著。 我正想著如何刺激一下我的同行們,也包括我自己,然後今天剛好看見了這麼一篇文章,強烈推薦給程式設計師單身小夥們閱讀

#浙大畢業生3萬月薪程式設計師做,去做網約車司機:我高興,我樂意

浙大畢業的高材生放棄程式設計師高薪去做網約車司機:昨天打網約車回家,遇到一位浙大畢業的程式設計師,放棄了3萬一月的程式設計師工作,成了專職的網約車司機,1萬塊錢一個月,圖的是自由自在,並稱有錢難買我開心,各位怎麼看? 這裡的一萬塊錢指的是毛利潤,扣除車輛運營成本後的收入,即使如此,這

#程式設計師完程式碼就被開除了,網友看完後:怎樣才能和你一樣優秀

程式設計師這行業可能對於一般人來說,你不入這行,是不懂行裡的門道的。網際網路行業的迅猛發展,很多人都選擇加入到程式設計師這個群體中來,現在很多人都說該行業呈飽和狀態,畢竟一年百萬級的程式設計師加入進來。 在這裡我推薦下自己整理的資料,我自己是一名從事了5年java開發的全棧工程師,如果有

未來,什麼樣的程式設計師會被淘汰?

就在近日,智聯招聘公佈的資料更是側面印證了很多公司“瘦身”的事實:“2018年第二季度,小微企業用人需求較第一季度平均下降26.6%”。 裁員大潮正滾滾向前,席捲各行各業! 你做好失業的準備了嗎? 作為世界第一程式語言,Java在程式設計界的地位毋庸置疑。當然,Java工程師也一直都是研

Java程式設計師完這段程式碼,就被開除了!網友:程式碼沒毛病啊

一般程式設計師寫的程式碼都是非常多的,畢竟這是一個技術活,需要多練習多實踐才能掌握。但是有一位程式設計師卻因為寫了一段程式碼就遭到領導開除! 在分享這篇文章之前呢,我先分享下我總結的一些乾貨,我自己也是一位從事了6年開發的全棧工程師,今年年初我整理了一份最適合2018年學習的java乾貨,包括基

程式設計師完程式碼,就被開除了,網友:你TM真是個天才

前幾天在逛貼吧的時候,看到這樣一個帖。一程式設計師說自己剛寫完程式碼,就別公司老闆給開除了。為什麼會這樣的呢? 原來是這位程式設計師寫了一段這樣的程式碼: public static Date getNextDay() { try { Thread.sleep(24*60*60

程式設計師成熟的若干個特徵

分享一下我老師大神的人工智慧教程!零基礎,通俗易懂!http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識,造福人民,實現我們中華民族偉大復興!        

懂演算法的程式設計師是好工程師--選擇排序

“大菜”:時刻提醒自己,技術之路修遠兮,予以自勉。 演算法主要衡量標準 時間複雜度(執行時間) 在演算法時間複雜度維度,我們主要對比較和交換的次數做對比,其他不交換元素的演算法,主要會以訪問陣列的次數的維度做對比。 其實有很多同學對於演算法的時間複雜度有點

前端程式設計師知道的14個JavaScript除錯技巧,你知道幾個?

技術領域總是充滿著神祕的未知和挑戰,有趣又令人不能自拔。就像 Java,即使是每天使用它進行開發互動的開發人員,而語言的某些部分仍然未被開發。 瞭解工具可以使工具最大限度的幫助你完成任務。儘管Java的除錯非常麻煩,但在掌握了技巧 (tricks) 的情況下,依然可以用盡量少的的時間解決這些錯誤

程式設計師程式碼得好,升職反而慢!網友:你說的沒毛病啊

大家都知道程式設計師是個高薪行業,因為想要當程式設計師也是一門技術活,不是那些流水線工作,只要你是正常人就能去幹的。一般來說,你技術越好變薪資越高,這確實沒毛病,你有多大能力那多高薪資。但是最近有程式設計師在網上發帖說道,程式碼寫得好反而升職滿,程式碼寫的爛得反而更容易升職。 該程式設計師

程式設計師加班,領導:想幹了就滾?

在工作中,加班不是目的,加班是為了完成工作,當員工能在正常上班時間內完成工作,無需加班,這時候作為領導也就沒有必要讓其留下來加班。 然而也有一些公司領導只看員工加不加班,就有一領導經過幾天的觀察,發現新來的幾名程式設計師每天晚上不到八點就早早的下班走了,對此這名領導很生氣,想管管這群新來

為什麼程式設計師部落格

作為一名計算機程式設計講師,在課程一開始,我就強調:“一定要做筆記,給自己申請一個部落格。” 理由如下: 一:整理思維、加強理解。 二:方便未來、回顧複習。 三、記錄成長。 四、鍛鍊寫作文字組織能力。 五、跟其他人反饋、互動,別人會發現一些你發現不了的問題,提升你的思維。