你看到過的最好的代碼注釋是什么樣的?
作者:外刊IT評論
編寫代碼良好的習慣就是寫清楚注釋,方便自己查閱也方便后來者熟悉代碼,然而很多人留下的代碼注釋卻讓你啼笑皆非
下面是stackoverflow網站上網友針對你看到過的***的代碼注釋是什么樣的?這個問題給出的回答的前10條:
- // 親愛的維護者:
- // 如果你嘗試了對這段程序進行‘優化’,
- // 并認識到這種企圖是大錯特錯,請增加
- // 下面這個計數器的個數,用來對后來人進行警告:
- // 浪費在這里的總時間 = 39h
- /** * 致終于來到這里的勇敢的人:
- 你是被上帝選中的人,英勇的、不辭勞苦的、不眠不修的來修改
- 我們這最棘手的代碼的編程騎士。你,我們的救世主,人中之龍,
- 我要對你說:永遠不要放棄,永遠不要對自己失望,永遠不要逃走,辜負了自己。
- 永遠不要哭啼,永遠不要說再見。永遠不要說謊來傷害自己。 */
- Exception up = new Exception("Something is really wrong."); throw up;
- // 一些修改1 - 2002/6/7 增加臨時的跟蹤登錄界面
- // 一些修改2 - 2007/5/22 我臨時的犯傻
- #define TRUE FALSE //逗一逗調試程序的傻瓜們
- if (/*you*/ $_GET['action']) { //celebrate(恭喜)
- // 如果這段代碼好用,那它是Paul DiLascia寫的。
- //如果不好用,我不知道是誰寫的。
- //寫這段代碼的時候,只有上帝和我知道它是干嘛的
- //現在,只有上帝知道
- // 暈了,以后再修改
- // 神奇。勿動。
你有沒有更絕的?
原文:http://www.aqee.net/10-best-code-comments/
【編輯推薦】
責任編輯:陳貽新
來源:
外刊IT評論