優秀的程式設計師真的不寫注釋嗎?

2022-01-22 10:40:00 字數 857 閱讀 5053

記得剛參加工作,經理就給組裡的人發了乙份他寫的專案**,當時面對這樣乙個大專案,看了幾天,組裡的人都抱怨**沒有注釋,難讀。這是經理就說了句話,我記到了現在:

「你們老是抱怨別人的**沒有注釋,可是你們有給自己的**寫注釋嗎?」

有些大牛也覺得給自己的**加上注釋,就好像是對他的一種侮辱:「我的**寫得這麼優雅,你難道看不懂嗎?注釋是多餘的!」

的確如此,我們希望看到別人的注釋,同時又不想給自己的**寫注釋。對於那些開源大型專案,一般會有良好的注釋,團隊本身也非常優秀,管理規範,專案擁有大量的使用者,這類專案一般不會缺少注釋,是否自願的就不一定了。

想必都讀過**的人都有體會,在自己水平範圍內,實現某個功能和看懂別人的實現**,後者的難度往往大於前者。儘管很多人說好**不需要注釋,本身就是「自注釋」。但是你會發現,說這種話的人,要麼是大牛,要麼是菜鳥。就身邊的觀察而已,當讀別人的**時,是希望有必要的注釋的。

大多數公司裡,接手別人的**,是缺乏必要的注釋的。github上的個人repositories是普遍缺乏注釋的。他們為什麼不寫注釋?

因為寫注釋是利他行為。

特別是公司專案,接手**的是同職位的人,互為競爭。因此,即使公司規範中要求寫注釋,你也明明知道,以後會有人接手你的專案,可是你很少會為後人寫注釋。我接手過10個專案,只有乙個專案是有少許注釋的。

帶有注釋的**已成為一種奢望。如果你是專案組長,與其勉強同事們寫上注釋,不如提倡coding without comments。當不提倡寫注釋時,他們會更用心地寫好變數名,函式名。不得不承認,注釋雖好,寫好卻難。比如維護困難,當實現修改後,注釋經常忘記同步。有的注釋是模糊的,多餘的。時間久遠後,誰也搞不懂這段注釋是什麼意思了。可見,即使要寫注釋,盡量是簡明扼要。

寫好注釋跟寫好**一樣,是藝術活。

程式設計師你真的只是程式設計師嗎?

進來了吧 你是不是感覺標題有點矛盾啊,是啊,程式設計師當然就只是程式設計師而已嘛,還會有其他什麼嗎?no,no,no,如果你以前是如此認為的,那看完這篇文章後,請從此打消這個念頭,因為你要改變成乙個不一樣的程式設計師 怎麼還是程式設計師?雖然我工作經驗也就6年左右,但經歷了很多,也自己創業過,也是從...

你是優秀程式設計師嗎?

投遞人 astar 發布於 2011 08 22 10 03 有1420人閱讀 收藏 are you a good programmer?如果有人要你推薦一名優秀的程式設計師,你會想到誰?你認為你自己是嗎?你的評判標準是什麼?思考了這個問題,我意識到程式設計師可以以各種方式做到優秀。所以我向你推出 ...

程式設計師真的是鉗工嗎

以前在乙個社群泡時,那裡面的人老說程式設計師是鉗工,受不了了,所以跑出來了.真的是這樣嗎?我今年大2,讀的是軟體工程專業,一是由於興趣,二是軟體工程是所有高校裡收費最高的,平均沒年1w.稍便宜的也有.我想應該是個好專業吧.現在聽到這樣說很是彷徨.弄的沒心思讀書.另外老爸也不是很贊成我讀這專業,但未來...