java注释详解

注释的原则 　　1、 注释形式统一 　　在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。 　　2、 注释的简洁 　　内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。 　　3、 注释的一致性 　　在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。 　　4、 注释的位置