【實踐】如何合理地在代碼中添加註釋

      從開始學編程到今天之前,看到各種書籍資料中都提到爲了自己養成編碼的好習慣,並且讓自己以後及其他相關人員能看懂代碼,要對代碼添加註釋。但今天,本以爲自己已經“養成”了這個所謂的好習慣而沾沾自喜時,老大卻把我“教訓”了一番:添加註釋不要過於“濫”,要合理適度。

      以前看到添加註釋方面的資料介紹時,自己都很認真謙虛地學習,所以在我自己的代碼中,都用英文名稱(本人英文還算不錯)儘量把類,枚舉,各種方法,成員變量,屬性等等寫得讓人一看就明瞭的感覺。這的確是個不錯的習慣,怪不得有些牛人們經常說:“我的代碼就是註釋!”直到今天被老大“教訓”我時,我纔算真正明白了這點。

      老大說:“既然名稱都已經明瞭了,那爲什麼還要加那麼多的註釋呢(幾乎每行都加),我們又不是像微軟SUN那樣做底層的,不會把註釋都轉換成API開發接口文檔。我們應該把註釋加在那些需要在今後引起人們注意的代碼上,比如這裏可能拋異常,那裏爲什麼要用A方式來做而不用B方式,當然還有在意思上比較模糊讓人混淆的地方等等。”

      代碼註釋的方式,從來就沒有一個完全的定義,要麼是根據微軟SUN這些公司建議的規則(也僅僅是建議而已),要麼是根據項目自身需要來制訂的。但我們更能通過平時的工作來學會更加成熟地爲代碼添加註釋---不是越多越好,應該合理適度。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章