程式員為什麼不寫注釋_程式員

來源:互聯網
上載者:User


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

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.