Java注释与注解

二、补充

1、Java中注释的问题：

/**......*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符 
注释文档将用来生成HTML格式的代码报告，所以注释文 
档必须书写在类、域、构造函数、方法，以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。

/*......*/注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。

2、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包中的有关描述。

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

4、1、单行(single-line)--短注释：//…… 单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。 注释格式：/* 注释内容 */ 行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式：// 注释内容 行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。 注释格式：代码 + 8（至少4）个空格 + // 注释内容 2、块(block)--块注释：/*……*/ 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成： /* * 注释内容 */ 3、文档注释：/**……*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...

5、首先说注释三种：//      /* */        /** */                前两种编译器直接跳阅读第三种编译器看懂使用javadoc命令用用API用
 
注解：东东完全给编译器看 比@Ovrride表示重写父类自定义所候编译器检查名否父类否写错
 
起初注解比较简单注解面加入变量参数节省代码（些代码都家共同认用公式给代替）
 
注解计算机说明用注解自写代码告诉计算机编译器  注解其实代码看起我自写点已代码部习HibernateSpring等候量用注解用节省量代码