千萬要避免的五種程式注釋方式

你是否有過複查程式時發現有些注釋毫無用處？程式注釋是為了提高**的可讀性，為了讓原作者以外的其他開發人員更容易理解這段程式。

public

class

program

}這種程式設計師是如此的欣賞自己的程式，以至於不得不在每行**上都署上自己的大名。應該讓版本控制系統來提供程式變更的資訊，他這樣做一眼看去並不能說明誰對這行**負責。

public

class

program}}

如果一段程式不再有用（比如廢棄了），那就刪了它吧——不要被幾行沒用的注釋搞的程式混亂不堪。即使你可能以後重用這段**，你也可以使用版本控制系統，用它把你的程式恢復到以前的樣子。

public

class

program}}

基本的程式設計語法規則我們大家都知道——我們不需要「程式設計入門」。你不需要浪費時間來解釋乙個顯而易見的東西，我們更希望知道的是你的程式功能——那是浪費空間了。

public

class

program

elseif(

datetime

.today

.dayofweek

==dayofweek

.wednesday

)else

commission

=price

*commissionrate;}

}如果你不得不在注釋裡寫明需求，那也不要提到人名。銷售員jim很可能在公司裡不再是銷售。而且大多數讀到這段注釋的程式設計師未必都知道jim是誰。你描述的是實際情況但跟我們的內容不相干，所以就省掉吧。

public

class

program}}

這種注釋是一種集大成者，它包含了上面所說的注釋的所有問題。todo注釋在乙個專案最初的開發階段是非常有用的，但這個注釋看起來是在好幾年前的產品程式裡的——它證明了程式有問題。如果程式有問題需要解決，馬上解決，不要拖到日後再解決。

如果你寫過這樣的注釋，或者是你正在尋找一種最好的注釋方案，我推薦你讀一讀steve mcconnell寫的code complete這本書。這是我推薦給所有程式設計師必讀的六本書中的一種。或者你可以學學如何停止注釋你的程式(英文)。