您的位置:首頁 > 學(xué)生信息 > 學(xué)習(xí)心得
來源:北大青鳥飛迅校區(qū)|發(fā)布時間:2013-04-20 16:42:18
注釋,本是提高代碼可讀性、讓其他開發(fā)人員更快速地理解程序的,然而一些無意義的注釋會讓人郁悶至極。本文是國外網(wǎng)站GreaterGeek上的一篇文章,作者通過分類介紹了五種一定要避免的程序注釋方式。
全文如下:
你是否有過復(fù)查程序時發(fā)現(xiàn)有些注釋毫無用處?程序注釋是為了提高代碼的可讀性,為了讓原作者以外的其他開發(fā)人員更容易理解這段程序。
我把這些讓人郁悶的注釋方式歸為了五類,同時把寫出這些注釋的程序員也歸為了五類。我希望讀了這篇文章后你感覺自己不屬于其中的任何一種類型。如果你有興趣的話可以讀一下另外一篇文章 五種程序員(英文),和這篇講到的五種程序員對比一下。
1. 高傲的程序員
1. public class Program
2. {
3. static void Main(string[] args)
4. {
5. string message = “Hello World!”; // 07/24/2010 Bob
6. Console.WriteLine(message); // 07/24/2010 Bob
7. message = “I am so proud of this code!”; // 07/24/2010 Bob
8. Console.WriteLine(message); // 07/24/2010 Bob
9. }
10. }
這種程序員是如此的欣賞自己的程序,以至于不得不在每行代碼上都署上自己的大名。應(yīng)該讓版本控制系統(tǒng)來提供程序變更的信息,他這樣做一眼看去并不能說明誰對這行代碼負(fù)責(zé)。
2. 過時的程序員
1. public class Program
2. {
3. static void Main(string[] args)
4. {
5. /* 這段程序已經(jīng)不再有用
6. * 因為我們發(fā)現(xiàn)千年蟲問題只是一場虛驚
7. * 我們的系統(tǒng)不會恢復(fù)到1/1/1900 */
8. //DateTime today = DateTime.Today;
9. //if (today == new DateTime(1900, 1, 1))
10. //{
11. // today = today.AddYears(100);
12. // string message = “The date has been fixed for Y2K.”;
13. // Console.WriteLine(message);
14. //}
15. }
16. }
如果一段程序不再有用(比如廢棄了),那就刪了它吧——不要被幾行沒用的注釋搞的程序混亂不堪。即使你可能以后重用這段代碼,你也可以使用版本控制系統(tǒng),用它把你的程序恢復(fù)到以前的樣子。
3. 天真的程序員
1. public class Program
2. {
3. static void Main(string[] args)
4. {
5. /* 這個程序是用來在屏幕上
6. * 循環(huán)打印1百萬次”I Rule!”
7. * 每次輸出一行。循環(huán)計數(shù)
8. * 從0開始,每次加1。
9. * 當(dāng)計數(shù)器等于1百萬時,
10. * 循環(huán)就會停止運行*/
11.
12. for (int i = 0; i < 1000000; i++)
全程面授,不高薪都難
申請成功后,我們將在24小時內(nèi)與您聯(lián)系
招生熱線: 4008-0731-86 / 0731-82186801
學(xué)校地址: 長沙市天心區(qū)團結(jié)路6號
Copyright © 2006 | 湖南大計信息科技有限公司 版權(quán)所有
湘ICP備14017520號-3