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 ......
项目中需要和第三方平台接口，加了来源IP鉴权功能，测试时发现没有问题，但是部署以后发现存在问题，一直鉴权不通过，一群人抓瞎。
我找到那块的代码，跟了一遍流程发现逻辑没有啥问题，但是最终的结果却还是鉴权不通过，实在有些诡异。其基本逻辑为先取得配置的IP列表，然后通过request.getRemoteAddr()取得客户端的IP� ......
命令行参数处理是一项令人厌烦的零碎工作，不管您过去已经处理过多少次了，它好像总能重新摆在您的面前。与其一遍又一遍地编写同
一块代码的不同变种，为什么不利用反射来简化参数处理的工作呢？Java 顾问 Dennis Sosnoski
向您展示了如何做到这一点。在本文中，Dennis 简明扼要地介绍了一个开源库，这个库可以使得命令行 ......
上学时很多问题的答案，可以从下文找到
JAVA语言学校的危险性
作者：Joel Spolsky
译者：阮一峰
原文： http://www.joelonsoftware.com/articles/ThePerilsofJavaSchools.html
译文地址：htt ......
Java如何操作Word, Excel, PDF文档？
http://www.sina.com.cn 2006年08月23日 14:55 太平洋电脑网
作者：盛忠良
参考:
http://danadler.com/jacob/
http://jakarta.apache.org/poi/
http://www.onjava.com/pub/a/onjava/2003/01/22/poi.html
http://www.c ......
