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

https://blog.csdn.net/huangsiqian/article/details/82725214 Javadoc工具将从四种不同类型的“源”文件生成输出文档：Java语言类的源文件（.java），包注释文件，概述注释文件和其他未处理的文件。 包注释文件（Package ...

前言： 现在java的出产地sun公司并没有定义一个java注释规范，注释规范目前是每个公司自己有自己的一套规范，主要是为了团队之间的协作。 1、基本规则 1.注释应该使代码更加清晰易懂 2.注释要简洁明了，只要提供能够明确理解程序 ...

一、注释格式分类： 　　1、单行(single-line)注释：//…… 　　2、块(block)注释：/*……*/ 　　3、文档注释：/**……*/ 　　javadoc有如下： 　　 二、加注释的场景： 　　1. 基本注释（必须加）　　　　(a)类（接口）的注释　　　　(b ...

一、命名规范 1、 项目名全部小写 2、 包名全部小写 3、 类名首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写。 如：public class MyFirstClass{} 4、 变量名、方法名首字母小写，如果名称由多个单词组成，每个单词的首字母都要大写。 如：int ...

1、 文件头注释 每一个文件的文件头都必须做文件头注释。文件头注释范例如下： 2、 方法头注释 每一个成员方法（包括自定义成员方法、覆盖方法、属性方法）的方法头都必须做方法头注释 ...

一、命名规范 Package 的命名 　　Package 的名字应该都是由一个小写单词组成。 Class 的命名 　　Class 的名字必须由大写字母开头而其他字母都小写的单词组成 Class 变量的命名 　　变量的名字必须用一个 ...

基本的要求： 1、注释形式统一 在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。 2、注释内容准确简洁 内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无 ...