公司項目經(jīng)理突然跑到我們幾個研發(fā)這里，跟我們說項目代碼要寫注釋。被他這么一說，我們一頭霧水，我就跟項目經(jīng)理說，項目代碼里該寫的注釋都寫了呀，結(jié)果項目經(jīng)理說：“我看了你們寫的代碼，好多地方都沒寫注釋，你們最好把注釋補全了！”，并且還說了一大堆不寫注釋會導(dǎo)致的后果，聽完，我們只能尷尬一笑，表示補就補一下吧！

項目經(jīng)理之所以突然要我們補全項目代碼里面的注釋，我估計是老板聽到了某些風(fēng)聲，怕我們公司某些程序員突然不干了，然后代碼又沒寫注釋，導(dǎo)致接手他項目的其他程序員看不懂他寫的代碼。所以，就讓項目經(jīng)理專門去看了下我們寫的項目代碼，如果沒有寫注釋就讓我們補全。

我覺得老板的初心是沒錯的，但是我們的項目經(jīng)理不是干軟件出身，所以，他對于我們寫的代碼里面沒有寫注釋是有誤解的。

他所謂的我們很多地方?jīng)]有寫注釋，那是因為我們只對大部分的字段、函數(shù)寫了注釋，具體到每段邏輯，如果不是特別繞的話，我們基本不會特別在每個函數(shù)體內(nèi)的某個代碼段去寫注釋。所以，項目經(jīng)理覺得我們應(yīng)該在函數(shù)體內(nèi)的邏輯里盡量都寫上注釋。

作為代碼老司機(jī)的我，直接跟項目經(jīng)理說了這么一段話：“如果代碼不是特別繞的話，寫注釋的效果反而可能會影響未來看這段代碼的人的思考！并且，幾乎只有新手才會在函數(shù)體內(nèi)頻繁寫注釋！”

說完這句話，項目經(jīng)理表示我在瞎說，還要我給他解釋下我的邏輯。

我大概是這么告訴他的：“其實，只要在函數(shù)的頭部寫上注釋就行了，如果一個人實在看不懂某個函數(shù)里面的代碼，即使寫上了注釋，他依然還是看不懂，但是，如果他真看不懂某段代碼，寫上了注釋反而會影響這個人的判斷，因為，并不是所有程序員都能寫好注釋，大多是情況下在代碼段里面寫的注釋，起到的正面作用遠(yuǎn)遠(yuǎn)小于其起到的負(fù)面作用！”

其實，我的意思很簡單，我想表達(dá)兩點意思，第一個就是很多程序員并不會寫注釋，而一旦這個程序員注釋寫的不好，會導(dǎo)致后面看的人先入為主，影響其判斷。

同為程序員，我不知道大家跟我的感受是否一樣，那就是經(jīng)常會被別人寫的注釋誤導(dǎo)，盡管是自己寫的注釋，也是這樣的。

所以，我寫代碼，基本上就只對字段名和函數(shù)名寫注釋，原因在于，很多字段起名使用拼音覺得Low，所以經(jīng)常用翻譯軟件翻譯將中文翻譯成英文，但是，過段時間就不認(rèn)識了，所以寫上注釋，方便快速知道其意思。

函數(shù)差不多也是這個考慮，像函數(shù)名、入?yún)⒌膮?shù)名、返回值的名稱，寫上注釋一來是時間長了真不知道是什么意思，二來也能通過注釋快速知道其含義。

其實，就跟我們調(diào)用很多編程語言自帶的函數(shù)一樣，鼠標(biāo)懸浮上去，就會有函數(shù)的具體作用以及每個函數(shù)入?yún)⒑统鰠⒌木唧w含義。

但是，這種說法顯然沒有說服我們的項目經(jīng)理，所以，我們只能找個時間去將代碼里面的注釋給補齊。

結(jié)語

后來我們項目經(jīng)理私下跟我說，讓我們寫注釋只是因為老板收到了風(fēng)聲，說我們部門有些人私下跟同事說不想干了，結(jié)果這件事情被老板知道了，所以老板才讓研發(fā)部門補全注釋，以防到時候出什么亂子，影響工作效率。

但是，我覺得即使是這樣，臨時讓人補全注釋，其實也未必能達(dá)到目的，因為只要有心之人，故意在注釋上動手腳，后面給公司帶來的麻煩更大。

您覺得呢？