Java注释规范
Java注释规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）。
Java 的语法与 C++ 及为相似，那么，你知道 Java 的注释有几种吗？是两种？
// 注释一行
/* ...... */ 注释若干行
不完全对，除了以上两种之外，还有第三种，文档注释：
/** ...... */ 注释若干行，并写入 javadoc 文档
注释要简单明了。
String userName = null; //用户名
边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。
在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防
止注释二义性。保持注释与其描述的代码相邻，即注释的就近原则。
对代码的注释应放在其上方相邻位置，不可放在下面。对数据结构的注释应放在
其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方；
同一结构中不同域的注释要对齐。
变量、常量的注释应放在其上方相邻位置或右方。
全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以
及存取时注意事项等的说明。
在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日
期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文
件关系等）；主要函数或过程清单及本文件历史修改记录等。
Java代码
/**
* Copy Right Information : Neusoft IIT
* Project : eTrain
* JDK version used : jdk1.3.1
* Comments : config path
* Version &n
相关文档：
/**
* 堆排序
*
* */
public void heapSort(double[] a){
double temp;
initCreateHeap(a);
for(int i = a.length - 1; i > 0; i --){
temp = a[0];
a[0] = a[i];
a[i] = temp;
createHeap(a, i, 0);
}
}
/**
* 将数组看成完全二叉树，建立最大堆
* */
private ......
这一有关 Java 编程动态方面的新的系列文章研究了执行 Java 应用程序时幕后所发生的事情。企业 Java专家
Dennis Sosnoski 提供了 Java 二进制类格式以及在 JVM
内部类所发生的情况的内幕。接着，他将讨论类装入问题，其范围涉及从运行简单的 Java 应用程序所需的类的数量到可能造成 J2EE
及类似的复杂体系结构出现问题的 ......
Apache Byte Code Engineering Library (BCEL)可以深入 Java
类的字节码。可以用它转换现有的类表示或者构建新的类，因为 BCEL 在单独的 JVM
指令级别上进行操作，所以可以让您对代码有最强大的控制。不过，这种能力的代价是复杂性。在本文中，Java 顾问 Dennis Sosnoski
介绍了 BCEL 的基本内容，并引导读者完成一个示� ......
反射使您的程序代码能够接入装载到JVM中的类的内部信息，允许您编写与执行时，而不是源代码中选定的类协作的代码。这使反射成
为构建灵活的应用的主要工具。但需注意的是 --如果使用不当，反射的成本很高。在Java平台系列的第2部分中，软件顾问Dennis
Sosnoski介绍了如何使用反射，以及某些相关的成本。您还将找到JavaRef ......
