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