主頁 > 知識庫 > 千萬要避免的五種程序注釋方式小結(jié)

千萬要避免的五種程序注釋方式小結(jié)

熱門標(biāo)簽:地圖標(biāo)注和圖片標(biāo)注 醫(yī)院地圖標(biāo)注 滄州智能外呼系統(tǒng)收費 嘟聲的電銷機器人 語音平臺系統(tǒng) 湖北穩(wěn)定外呼系統(tǒng) 電銷機器人怎么收費 洛陽便宜外呼系統(tǒng)廠家 忻州外呼系統(tǒng)接口對接
我把這些讓人郁悶的注釋方式歸為了五類,同時把寫出這些注釋的程序員也歸為了五類。我希望讀了這篇文章后你感覺自己不屬于其中的任何一種類型。如果你有興趣的話可以讀一下另外一篇文章 五種程序員(英文),和這篇講到的五種程序員對比一下。

1. 高傲的程序員
復(fù)制代碼 代碼如下:

public class Program
{
static void Main(string[] args)
{
string message = “Hello World!”; // 07/24/2010 Bob
Console.WriteLine(message); // 07/24/2010 Bob
message = “I am so proud of this code!”; // 07/24/2010 Bob
Console.WriteLine(message); // 07/24/2010 Bob
}
}

這種程序員是如此的欣賞自己的程序,以至于不得不在每行代碼上都署上自己的大名。應(yīng)該讓版本控制系統(tǒng)來提供程序變更的信息,他這樣做一眼看去并不能說明誰對這行代碼負(fù)責(zé)。

2. 過時的程序員
復(fù)制代碼 代碼如下:

public class Program
{
static void Main(string[] args)
{
/* 這段程序已經(jīng)不再有用
* 因為我們發(fā)現(xiàn)千年蟲問題只是一場虛驚
* 我們的系統(tǒng)不會恢復(fù)到1/1/1900 */
//DateTime today = DateTime.Today;
//if (today == new DateTime(1900, 1, 1))
//{
// today = today.AddYears(100);
// string message = “The date has been fixed for Y2K.”;
// Console.WriteLine(message);
//}
}
}

如果一段程序不再有用(比如廢棄了),那就刪了它吧——不要被幾行沒用的注釋搞的程序混亂不堪。即使你可能以后重用這段代碼,你也可以使用版本控制系統(tǒng),用它把你的程序恢復(fù)到以前的樣子。

3. 天真的程序員
復(fù)制代碼 代碼如下:

public class Program
{
static void Main(string[] args)
{
/* 這個程序是用來在屏幕上
* 循環(huán)打印1百萬次”I Rule!”
* 每次輸出一行。循環(huán)計數(shù)
* 從0開始,每次加1。
* 當(dāng)計數(shù)器等于1百萬時,
* 循環(huán)就會停止運行*/

for (int i = 0; i 1000000; i++)
{
Console.WriteLine(“I Rule!”);
}
}
}

基本的編程語法規(guī)則我們大家都知道——我們不需要“編程入門”。你不需要浪費時間來解釋一個顯而易見的東西,我們更希望知道的是你的程序功能——那是浪費空間了。

4. 傳奇的程序員
復(fù)制代碼 代碼如下:

public class Program
{
static void Main(string[] args)
{
/* 有一天我在大街上的一家星巴克里
* 和銷售部的Jim討論問題,他告訴我
* 銷售代表是依據(jù)以下的比例提取傭金的。
* 周五: 25%
* 周三: 15%
* 其它日期: 5%
* 我是否告訴你過我點了一個卡拉梅
* 鐵咖啡和兩份的Espresso?
*/
double price = 5.00;
double commissionRate;
double commission;
if (DateTime.Today.DayOfWeek == DayOfWeek.Friday)
{
commissionRate = .25;
}
else if (DateTime.Today.DayOfWeek == DayOfWeek.Wednesday)
{
commissionRate = .15;
}
else
{
commissionRate = .05;
}
commission = price * commissionRate;
}
}

如果你不得不在注釋里寫明需求,那也不要提到人名。銷售員Jim很可能在公司里不再是銷售。而且大多數(shù)讀到這段注釋的程序員未必都知道Jim是誰。你描述的是實際情況但跟我們的內(nèi)容不相干,所以就省掉吧。

5. 未來程序員
復(fù)制代碼 代碼如下:

public class Program
{
static void Main(string[] args)
{
//TODO: 將來我會修復(fù)這個問題 – 07/24/1995 Bob
/* 我知道這個問題很難解決而且
* 我現(xiàn)在依賴于這個Contains函數(shù),但
* 我以后會用一種更有意義,更
* 優(yōu)雅的方式打印這段代碼。
* 我只是現(xiàn)在沒時間。
*/
string message = “An error has occurred”;
if(message.Contains(“error”))
{
throw new Exception(message);
}
}
}

這種注釋是一種集大成者,它包含了上面所說的注釋的所有問題。TODO注釋在一個項目最初的開發(fā)階段是非常有用的,但這個注釋看起來是在好幾年前的產(chǎn)品程序里的——它證明了程序有問題。如果程序有問題需要解決,馬上解決,不要拖到日后再解決。

如果你寫過這樣的注釋,或者是你正在尋找一種最好的注釋方案,我推薦你讀一讀Steve McConnell寫的Code Complete這本書。這是我推薦給所有程序員必讀的六本書中的一種。或者你可以學(xué)學(xué)如何停止注釋你的程序(英文)。

你是否在你的程序里還見到過其它種沒有意義的或討厭的注釋?歡迎共享。

標(biāo)簽:日照 山南 宜賓 內(nèi)蒙古 定州 巴彥淖爾 96 防城港

巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《千萬要避免的五種程序注釋方式小結(jié)》,本文關(guān)鍵詞  千萬,要,避免,的,五種,程序,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請?zhí)峁┫嚓P(guān)信息告之我們,我們將及時溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。
  • 相關(guān)文章
  • 下面列出與本文章《千萬要避免的五種程序注釋方式小結(jié)》相關(guān)的同類信息!
  • 本頁收集關(guān)于千萬要避免的五種程序注釋方式小結(jié)的相關(guān)信息資訊供網(wǎng)民參考!
  • 推薦文章