注释

2005年8月12日

程序元素(通常是类、方法或字段)上的注释是添加到该程序元素的元数据,可用于用额外的代码来修饰该元素。

Java中,这被称为注释,在C#中,这被称为属性。C#从第一个版本开始就有了它们,而在Java中,它们出现在1.5版本中。

属性的一个很好的例子是C#中的[Obsolete]属性,用于标记即将停止使用的元素(与Java中的已弃用相同)。Obsolete属性可以接受参数来打印消息并指示使用该元素是错误还是警告。语言平台附带了许多定义的注释,但允许您添加自己的注释。

在编写关于编程的文章时,我更喜欢使用“注释”作为通用术语。虽然.NET是第一个,但“属性”这个词在不同的东西中使用得太广泛了。

语言可能会以不反映语言语法的形式提供注释,例如RubyAnnotations非常常见 - 但它们是通过类方法完成的。