JAVA 注释

 

Override,Deprecated ,SupressWarning

　　A、Override，只能用于方法（不能用于类，包括声明或者其他结构）

　　作用：可以保证编译时Override函数的声明正确性。

　　用法：@Override

　　public void fun() {……}

　　B、Deprecated 同样只能用于方法。

　　作用：对不应再使用的方法进行注解。

　　用法：@Deprecated public void fun{……} //这个注释与函数在同一行。

　　C、SupressWarnings 可以注释一段代码。

　　作用：关闭特定的警告信息。例如你在使用泛型的时候未指定类型。

　　用法：@SupressWarnings(value={"unchecked"})

　　……代码

注释@deprecated与@Deprecated的区别

　　用 @Deprecated注释的程序元素，不鼓励程序员使用这样的元素，通常是

　　因为它很危险或存在更好的选择。在使用不被赞成的程序元素或在不被赞成的

　　代码中执行重写时，编译器会发出警告。

　　其次，请注意标题，这两个标记有大小写之分，一个是D，一个是d。

　　源代码标记@Deprecated是在JDK1.5中作为内置的annotation引入的，用于表

　　明类(class)、方法(method)、字段(field)已经不再推荐使用了，并且在以后的

　　JDK版本中可能将其删除，编译器在默认情况下检测到有此标记的时候会提示

　　警告信息。

　　Java注释中的@deprecated用于在用Javadoc工具生成文档的时候，标注此类/

　　接口、方法、字段已经被废止。

　　不 过后者还有一个功能就是和源代码标记@Deprecated同样的功能，在JDK1.4

　　版本之后，该功能被@Deprecated所取代。

　　java.lang.Deprecated是J2SE 5.0中标准的Annotation型态之一，它对编译

　　器说明某个方法已经不建议使用，如果有人试图使用或重新定义该方法，必须

　　提出警示讯息。原文：(A program element annotated @Deprecated is one that programmers are discouraged from using, typically because it is dangerous, or because a better alternative exists. Compilers warn when a deprecated program element is used or overridden in non-deprecated code.)

　　举个例子来说，您可能定义一个CustomObject类别，并在当中定义有

　　getSomething()方法，而在一段时间之后，您不建议使用这个方法 了，并要

　　将这个方法标示为deprectated，您可以这么作：

　　CustomObject.java

　　public class CustomObject {

　　@Deprecated public String getSomething() {

　　return "something";

　　}

　　}

　　如果有人试图在继承这个类别后重新定义getSomething()，或是在程序中呼叫

　　使用getSomething()方法，则进行编译时，就会出现这 个警讯：

　　Note: SubCustomObject.java uses or overrides a deprecated API.

　　Note: Recompile with -Xlint:deprecation for details.想要知道详细的警

　　讯内容的话，可以在编译时加上-Xline:deprecation自变量，例如：

　　>javac -Xlint:deprecation SubCustomObject.java

　　SubCustomObject.java:5: warning: [deprecation] getSomething() in

　　CustomObject ha s been deprecated

　　object.getSomething();

　　^

　　1 warningjava.lang.Deprecated是个Marker annotation，简单的说就是用于

　　标示，annotation名称本身即包括了要给工具程序的信息。

 

通过注释提高Java源程序代码的可读性；使得Java程序条理清晰，易于区分代码行与注释行。另外通常在程序开头加入作者，时间，版本，要实现的功能等内容注释，方便后来的维护以及程序员的交流。