註解

2005 年 8 月 12 日

程式元素(通常是類別、方法或欄位)上的註解是一段附加到該程式元素的元資料,可用於使用額外程式碼來修飾該元素。

Java 中,這稱為 註解,在 C# 中,這稱為 屬性。C# 從其第一個版本就有了屬性,在 Java 中,它們出現在 1.5 版中。

屬性的好範例是 C# 中的 [Obsolete] 屬性,用於標記即將停用的元素(與 Java 中的已棄用相同)。Obsolete 屬性可以採用引數來列印訊息,並指出使用該元素是錯誤還是警告。語言平台附帶許多已定義的註解,但允許您新增自己的註解。

在撰寫有關程式設計的文章時,我比較喜歡使用「註解」作為一般術語。儘管 .NET 是最早的,但「屬性」這個詞對於不同的東西來說使用得太廣泛了。

語言可能會以不反映語言語法的方式提供註解,例如 RubyAnnotations 非常常見,但使用類別方法完成。