Question

java中注释的问题

我是一个java菜鸟，java的注释我老用//和/*……*/写。这几天冷不丁看到一个"/**"，不知这是什么东西，查了一下好像是给javadoc用的，里面要加@...，是什么注解，但是我也看到在/**外面也有@，例如@overridden，是检查覆盖方法的……请哪位java高手告诉我/**、@和javadoc是干什么用的，谢谢了。

Answer 1

DOC注释/**------*/是完全为javadoc服务的会被编译识别。

@打头的表示注解，注解这个东西是JDK1.5提出来的，表示一个类(class)、字段(field)或者方法(method)的属性(attribute)。

javadoc是javaAPI的一种方便实现，主要是为了别人对此类的阅读使用的方便，一般不影响类的功能。因为java之前的C/C++的api让你阅读起来非常不方便。

DOC注释里面的专门给出doc提示用的，如：注释内的@return 表示方法的返回值类型，它是在方法上的doc注解，即使你这个上面随便瞎写，不会影响类的编译和功能。

而在方法上面直接加的@Override，表示这个方法是覆盖来自超类(super class)的已知方法。
如果方法定义和超类的这个方法格式不合适，编译无法通过。

追问

那在doc注释里的@。。。具体有哪些？他们的语法是什么，如何工作？生成的doc里是怎么表示的？
还有，在注释内与注释外的@。。。有什么不同？分别都干什么用的？

追答

这个...
doc@里面的常见的有return表示方法返回值的、author表示作者的、表示参数的、表示异常的、表示版本号的等
至于标准注解，就多了去了。不过它们都是@interface(注解)类型的java类(首字母大写的)，在API中能够找到的。常见的有方法上面的@Override、还有表示类、字段、方法已经不被支持可能在下一版本弃用的、表示注释应用类型的(有些注释只能用于方法、有些是类的注释)、Resource 注释标记应用程序所需的资源的、Generated 注释用于标记已生成的源代码。它也可以用于区分单个文件中用户编写的代码和生成的代码。

建议感兴趣的话查看JDK-API中的java.lang.annotation包中的有关描述。

Answer 2

这是javadoc里的注释方法。其实和学java编程关系不大，不懂也不要紧

Answer 3

Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。而所谓特定的标签就是/**、@了，类似这样的：
/**
* 获取本季度所有已跑批的异常文档
* @author XXX
* @return 文档信息
* @throws SQLException
*/

Answer 4

同意 上楼

Sora_no_kiseki