<b>簡評:</b>要說到代碼注釋這個東西吧,其實很神奇,因為不管寫不寫注釋,其實對于代碼的運作沒有任何的影響,注釋的長短也沒關系,因為編譯器會對于所有的代碼注釋都是過濾掉的,其實注釋非常重要,對後期的代碼維護和重構至關重要,但是其實很多程式員童鞋在寫代碼時往往并不注意注釋,是以導緻自己回頭看自己的代碼時也都忘了寫的是什麼,本文給出了 stackoverflow 網友針對“你看到過的最好的代碼注釋是什麼樣的?”這個問題給出的回答的前10條。
<b>1、</b>
// 親愛的維護者:
// 如果你嘗試了對這段程式進行‘優化’,
// 并認識到這種企圖是大錯特錯,請增加
// 下面這個計數器的個數,用來對後來人進行警告:
// 浪費在這裡的總時間 = 39h
<b></b>
2、
/** * 緻終于來到這裡的勇敢的人:
你是被上帝選中的人,英勇的、不辭勞苦的、不眠不修的來修改
我們這最棘手的代碼的程式設計騎士。你,我們的救世主,人中之龍,
我要對你說:永遠不要放棄,永遠不要對自己失望,永遠不要逃走,辜負了自己。
永遠不要哭啼,永遠不要說再見。永遠不要說謊來傷害自己。 */
![](https://img.laitimes.com/img/__Qf2AjLwojIjJCLyojI0JCLicWZwpmLmFzY2QDOkNjM4QDNwE2NjRGZzMmYyQGMkFmZwcTO2cjN5MzNxI2Y48CXt92Yu4GZjlGbh5SZslmZxl3Lc9CX6MHc0RHaiojIsJye.jpeg)
<b>3、</b>
exception up = new exception("something is really wrong."); throw up;
<b>4、</b>
// 一些修改1 - 2002/6/7 增加臨時的跟蹤登入界面
// 一些修改2 - 2007/5/22 我臨時的犯傻
<b>5、</b>
#define true false //逗一逗調試程式的傻瓜們
6、
if (/*you*/ $_get['action']) { //celebrate(恭喜)
7、
//如果這段代碼好用,那它是paul dilascia寫的。
//如果不好用,我不知道是誰寫的。
<b>8、</b>
//寫這段代碼的時候,隻有上帝和我知道它是幹嘛的
//現在,隻有上帝知道
<b>9、</b>
// 暈了,以後再修改
10、
// 神奇。勿動。
<b>你有沒有遇到過更絕的?</b>
本文轉載自 stackoverflow 譯者:外刊it評論 連結:www.vaikan.com/10-best-code-comments/原文有修改