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
相关文档：
NVelocity是Java模板引擎Velocity的.Net版本。NVelocity目前官方版本为0.42。官方地址：http://nvelocity.sourceforge.net/，原作者已经申明不再对NVelocity做技术支持了，所以sourceforge上NVelocity版本一直是0.42不再有更新了。不过目前NVelocity已经有1.0的版本了，是由castleproject项目维护的。NVelocity.dll能在cast ......
项目中需要和第三方平台接口，加了来源IP鉴权功能，测试时发现没有问题，但是部署以后发现存在问题，一直鉴权不通过，一群人抓瞎。
我找到那块的代码，跟了一遍流程发现逻辑没有啥问题，但是最终的结果却还是鉴权不通过，实在有些诡异。其基本逻辑为先取得配置的IP列表，然后通过request.getRemoteAddr()取得客户端的IP� ......
这一有关 Java 编程动态方面的新的系列文章研究了执行 Java 应用程序时幕后所发生的事情。企业 Java专家
Dennis Sosnoski 提供了 Java 二进制类格式以及在 JVM
内部类所发生的情况的内幕。接着，他将讨论类装入问题，其范围涉及从运行简单的 Java 应用程序所需的类的数量到可能造成 J2EE
及类似的复杂体系结构出现问题的 ......
从本系列前面的文章中，您了解到反射的性能比直接访问要慢许多倍，并了解了用 Javassist 和 Apache
Byte Code Engineering Library （BCEL）进行classworking。Java 顾问 Dennis
Sosnoski 通过演示如何使用运行时 classworking，来用全速前进的生成代码取代反射代码，从而结束他的 Java 编程的动态性
系列。
既然您已经 ......
Apache Byte Code Engineering Library (BCEL)可以深入 Java
类的字节码。可以用它转换现有的类表示或者构建新的类，因为 BCEL 在单独的 JVM
指令级别上进行操作，所以可以让您对代码有最强大的控制。不过，这种能力的代价是复杂性。在本文中，Java 顾问 Dennis Sosnoski
介绍了 BCEL 的基本内容，并引导读者完成一个示� ......
