//收集了一小部分，忘记的时候过来查一下 java--hadoop部分 <P>是单独起个段落 （注意和<br>换行、<pre>再起一个段落 比较） <B>是加黑加粗 @param是参数 @author yanghl 作者 ...

java代码注释规范 一、规范存在的意义 应用编码规范对于软件本身和软件开发人员而言尤为重要，有以下几个原因： 1、好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护； 2、好的编码规范 ...

代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在诉求网二期开发中使用的代码注释规范，供大家参考下。 原则： 1、注释形式统一 在整个应用程序中，使用具有一致的标点和结构的样式 ...

规范需要平时编码过程中注意，是一个慢慢养成的好习惯 1.基本规则 1.注释应该使代码更加清晰易懂 2.注释要简单明了，只要提供能够明确理解程序所必要的信息就可以了。如果注释太复杂说明程序需要修改调整，使设计更加合理。 3.注释不仅描述程序做了什么， 还要描述为什么要这样做 ...

1. 引言 团队开发时，业务模块分配的越清晰，代码注释管理越完善，越有利于后面维护，后面再管理也方便不少。另外也起着"文字砖"的作用，你懂的。注释不需要很详细，把代码块方法块功能简述一下就行。不然三月后回头看就要骂人了，骂完发现是自己写的，啧啧啧... 三种常用的 Java ...

1.Doxygen简介 Doxygen是一个程序的文档产生工具，可以将程序中的注释转换成说明文档或者说是API参考手册，从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写，才能让Doxygen识别和转化。 目前Doxygen可处理的程序语言包含C/C++、Java ...

注释形式统一 在整个解决方案中，使用一致的标点和结构的样式来构造注释，是架起团队成员沟通的桥梁既可以提高程序开发效率，也可以保证程序的可维护性。但是请不要试图使用这个标准来破坏旧解决方案的注释规范。一个解决方案的规范标准一致性才是最重 ...

有人说，代码即注释，也就是通过你的代码就能看得懂你的代码逻辑是什么。但是对于大多数人来说，这有些不切实际，每个公司的研发团队成员的能力是不一样的，有的能力强，有的能力弱，能力强的体现在能解决若干问题，但是在编码规范方面却有待提高，能力弱的，有的能力弱的在代码规范方面却比所谓的能力强的要好 ...