寫(xiě)代碼不寫(xiě)注釋?zhuān)?！無(wú)注釋主義了解一下~

據說(shuō)，共產(chǎn)黨員入黨時(shí)需要面向黨旗宣讀誓言，在莊嚴、肅穆的氣氛中，宣誓人懷抱著(zhù)拳拳報國之心，壓抑著(zhù)胸中的激蕩不已，熱淚盈眶、目光堅定地朗讀簡(jiǎn)潔有力的誓言，沉甸甸的誓言中有一句話(huà)特別鼓舞人心：為共產(chǎn)主義奮斗終身。

“主義”實(shí)在是一個(gè)好東西，它看似虛無(wú)縹緲，卻可以指導國家和人民的工作和生活。當今社會(huì )正處于劇烈變革之中，各種主義粉墨登場(chǎng)，占據了不同群體的精神世界，犬儒主義、樂(lè )觀(guān)主義、民本主義、民族主義、實(shí)用主義、貿易保護主義、自由主義、資本主義、社會(huì )主義、達達主義、完美主義、教條主義等等，不一而足，每一個(gè)主義承托著(zhù)一個(gè)思想世界，各種主義讓我們獲得新知，受到教益，筆者在多年的科研工作生涯中摸爬滾打，一路荊棘，也漸漸在寫(xiě)代碼方面形成了自己的主義-無(wú)注釋主義！

1

有人說(shuō)，上帝給你關(guān)上一扇門(mén)，必然會(huì )為你開(kāi)啟一扇窗，筆者對此金句頷首低眉，深以為然。就拿我來(lái)說(shuō)吧，為人木訥，不善言談，典型一個(gè)三腳跺不出一個(gè)屁來(lái)的悶葫蘆，但是又頗喜寫(xiě)作，雖然文筆欠佳，卻也經(jīng)常文思涌動(dòng)，恨不能剝皮為紙，以血為墨，折骨為筆，寫(xiě)它個(gè)一死方休。

筆者不僅以文字記錄工作生活、思想感悟，曾經(jīng)，還以代碼為田，筆耕不輟，到了不寫(xiě)注釋就不寫(xiě)代碼的地步。當然，筆者的注釋也難脫俗套，范疇基本上只限于解釋代碼的設計思路、具體實(shí)現的注意事項、關(guān)鍵變量的作用、函數調用參數的說(shuō)明等內容。時(shí)過(guò)境遷，當時(shí)的心境也已難尋，現在想來(lái)，當時(shí)之所以要寫(xiě)注釋?zhuān)环矫媸茄幍妇仉S大流，別人都寫(xiě)咱也寫(xiě)，另一方面，很大程度上是下意識地以文字代替語(yǔ)言，就好像要給他人解釋代碼，生怕哪段代碼沒(méi)有注釋?zhuān)瑹o(wú)法卸掉口頭給他人講代碼的責任一般。

2

這個(gè)世界懲罰自由散漫的人，也同時(shí)在懲罰循規蹈矩之人。人通過(guò)各種教條給自己設置了多個(gè)條條框框，在編織的牢籠里自得其樂(lè )，也必然會(huì )受到桎梏自吞苦果。

“注釋”就是這樣一個(gè)牢籠。

星爺曾經(jīng)說(shuō)過(guò)，能力越大，責任就越大。隨著(zhù)技術(shù)水平的日益提高，領(lǐng)導開(kāi)始將更加復雜艱巨的任務(wù)放到我的肩頭，肩負領(lǐng)導囑托，懷抱精忠報國之心，我寫(xiě)的代碼也開(kāi)始越來(lái)越多，越來(lái)越復雜了，同時(shí)，代碼里的注釋也慢慢增多了。

寫(xiě)代碼自有其客觀(guān)規律，那就是：需要不斷地修改、完善、優(yōu)化。就像在泳池中不斷變換各種泳姿一樣，筆者孜孜不倦地調整、打磨代碼，看著(zhù)代碼日益精益、完美，頗有一種樂(lè )在其中、雖九死而猶未悔的體會(huì )，以至于代碼慢慢地變得面目全非，而注釋基本上依然固執地保持著(zhù)最初的模樣，就好似已然開(kāi)始自由泳，說(shuō)明書(shū)卻還是蛙泳的動(dòng)作講解，自由泳是繃腳掌，蛙泳是翻腳掌，欲不吃虧，可得乎？！

3

楞嚴經(jīng)中說(shuō)：如人以手，指月示人。彼人因指，當應看月。若復觀(guān)指以為月體，此人豈唯亡失月輪，亦亡其指。就是說(shuō)，假如有人用手指著(zhù)月亮給你看，你應該順著(zhù)手指的方向去看月亮，如果你不看月亮，反而仔細地研究起這只纖纖玉手那纖細玉潤的手指來(lái)，多半會(huì )像“不知妻美”的東哥那樣失了分寸，動(dòng)心而忍不了性的。

注釋就是那根手指，代碼才是那彎明月。

楞嚴經(jīng)這段話(huà)的真正意思是：我們學(xué)習佛陀的經(jīng)典，要通過(guò)這些語(yǔ)言文字，體悟它背后所蘊含的深深義理，靠此義理指示，明悟我們的清凈佛心。不能執著(zhù)在語(yǔ)言文字上，以為那就是佛心，就是佛法。那就永遠找不到清凈佛心了，因為把語(yǔ)言文字當作佛心，當作佛法，其實(shí)，已經(jīng)失去了佛心真正的大圓滿(mǎn)、大具足、大光明、大無(wú)礙了！

不同的是，代碼的變化總是在不經(jīng)意間悄悄發(fā)生的，曾幾何時(shí)，注釋這根手指所指向的已經(jīng)不是最新代碼這顆明月了，我本將心向明月，奈何明月照溝渠??！

既然注釋很難跟得上代碼的變化，為什么那么多技術(shù)大牛都像模像樣地給后晉菜鳥(niǎo)們諄諄教誨，告誡他們注釋很重要，要養成寫(xiě)注釋的習慣呢？我想主要原因應該可以歸結到大多數程序員都不寫(xiě)文檔的壞習慣上來(lái)。程序員這個(gè)群體大抵都沒(méi)有多少忠君思想，跳槽也是家常便飯，無(wú)論是小白還是大牛，都不可避免地碰到接手別人代碼的情形。從代碼傳承的角度，描述性強的注釋可以起到幫助理解他人代碼、盡快上手修改原有代碼的作用。

人在江湖飄，誰(shuí)能不挨刀，我相信很多人都遭遇過(guò)受困于別人天書(shū)般的代碼望天長(cháng)嘆的時(shí)刻，那種無(wú)奈和抓狂實(shí)在刻骨銘心，所以，從利人利己的角度，都希望別人能寫(xiě)注釋?zhuān)覍?xiě)得越詳細越好，最關(guān)鍵的，一定要和代碼對應起來(lái)，不能驢唇不對馬嘴。

可是，如果代碼本身就可以解釋自己呢？

如果說(shuō)，注釋面對人的世界，代碼直接面向機器的世界，那么，如果代碼本身既能面對人又能面對機器世界呢？如果注釋充當的是人-機器之間的橋梁的話(huà)，那么，何不直接讓代碼充當這個(gè)橋梁呢？

據說(shuō)孩子出生的時(shí)候，每對父母都會(huì )抓耳撓腮，反復掂量斟酌孩子的起名，過(guò)程之艱不忍描述。而想要寫(xiě)出閱讀性強的代碼來(lái)，對函數、變量的起名同樣需要操碎了心，函數什么作用，變量干嘛用的，函數名稱(chēng)能涵蓋它實(shí)現的所有作用嗎，相似變量名稱(chēng)之間的歧義怎么解決，源文件怎么組織，函數長(cháng)度怎么約束，枚舉怎么定義，這些都直接影響代碼的閱讀性。這還僅僅是代碼層面，設計方案層面呢？如果模塊化做得不夠好，模塊之間耦合性強，改這里影響那里，不寫(xiě)注釋把這些隱患描述出來(lái)，怎么能夠保證之后正確修改呢？

所以，不是不可以不寫(xiě)注釋?zhuān)遣粚?xiě)注釋?zhuān)鸵巫斡谔岣叽a的閱讀性，靠代碼本身解釋自己，這樣實(shí)在是太難了！

可是，誰(shuí)的人生又是輕松愉快的呢？堅持貫徹無(wú)注釋主義，就可以破釜沉舟，逼迫自己寫(xiě)出模塊化、結構化、可靈活修改、魯棒性強、閱讀性好的代碼來(lái)，正所謂置之死地而后生也！

后記

也許，人本來(lái)就是很難團結的，程序員這個(gè)群體總是很容易分出多個(gè)陣營(yíng)出來(lái)，在寫(xiě)不寫(xiě)注釋上，也是仁者見(jiàn)仁智者見(jiàn)智，筆者只是拋磚引玉，并不代表唯一準確的觀(guān)點(diǎn)，科學(xué)自有其客觀(guān)規律，不容觸犯，但同時(shí)，科學(xué)的大門(mén)異常寬廣，容得你犯下任何錯誤。對于程序員這個(gè)群體，灑家始終懷有尊敬愛(ài)戴的情愫，所以，倘若本文有所冒犯，還請各位兄弟姐妹們見(jiàn)諒。