你喜歡你的評論嗎？

理想的情況下您的程序可以與讀者代碼，而不是溝通在評論中。在我看來，編寫其他程序員可以快速理解的軟件的能力將最好的程序員從平均水平上分離出來。通常，如果您或您的同事無法理解沒有評論的代碼段，那麼這是一種「代碼味道」，重構應該是有序的。但是，會有一些古老的圖書館或其他整合，一些評論指導普通開發人員不一定是壞事。

來源

2008-09-23 16:07:35

通常的答案是：這取決於。我認爲，如果評論是好的或不好的，你寫評論的原因對於決定非常重要。有多種可能的原因徵求意見：

使結構更清晰（即其循環在這裏結束）

壞：這看起來像一個可能的代碼味道。爲什麼代碼如此複雜，以至於需要評論才能清除該問題？

解釋，什麼代碼確實

非常糟糕：這在我看來是危險的。通常會發生，你後來改變了代碼並忘記了評論。現在評論是錯誤的。這真是太糟了。

指示解決方法/一個bug修正

好：有時一個問題的解決方案似乎很清楚，但簡單的方法有問題。如果您解決了這個問題，那麼添加評論可能會有幫助，爲什麼選擇此方法。否則，另一位程序員以後會想，他會「優化」代碼並重新引入該錯誤。想想Debian OpenSSL問題。 Debian開發人員刪除了一個單位變量。通常情況下，單位變量是一個問題，在這種情況下，它是隨機性所必需的。代碼評論將有助於澄清這一點。

的文件，目的

好：有些文檔可從特殊格式的註釋（即的Javadoc）來生成。記錄公共APIs是有用的，這是必須的。重要的是要記住，該文檔包含代碼的意圖，而不是實現。因此，回答評論「爲什麼你需要這種方法（以及你如何使用它）」或者該方法是什麼？

來源

2008-09-23 16:10:25 Mnementh

我認爲刪除註釋的新動作很糟糕......原因是，有很多程序員認爲他們編寫的代碼很容易理解，並且不需要註釋。但事實上並非如此。

你閱讀其他人的代碼的百分比，並立即明白它..也許我讀了太多經典的asp，Perl和C++，但我讀的大多數東西都是棘手的撇去。

你有沒有讀過別人的代碼，並且完全被它迷惑了。你認爲他們在寫作的時候會想，這是廢話，但我並不在乎。他們可能認爲哦......這是非常聰明的，它會是快速的 SUPER。

來源

2008-09-24 20:09:52

看一看Code Complete。它最適合這樣的話題。

來源

2009-11-02 05:16:25

只是一些言論：

評論功能是無法從代碼（例如複雜的數學算法）可以容易地推斷出所有重要資料。

評論的問題是，他們需要像代碼一樣維護，但通常不會被維護。

我不喜歡的評論是這樣的：

// Create the "Analyze" button 
Button analyzeButton = new Button(); 
analyzeButton.Text = "Analyze"; 
analyzeButton.Location = new Point(100, 100); 
Controls.Add(analyzeButton);

更好：

CreateAnalyzeButton(); 


void CreateAnalyzeButton() 
{ 
    Button analyzeButton = new Button(); 
    analyzeButton.Text = "Analyze"; 
    analyzeButton.Location = new Point(100, 100); 
    Controls.Add(analyzeButton); 
}

現在代碼道出了原委。無需評論。

來源

2010-02-19 19:27:15 EricSchaefer

你喜歡你的評論嗎？

回答

相關問題