java-code-specification.md

@@ -235,23 +235,138 @@ setCounter(int count)
 ```
 
 #### 5.2 类名采用每个单词首字母大写的方式
+  对于首字母缩写词如HTTP，把它同普通单词一样处理即仅有第一个H大写，其余字母小写。
 #### 5.3 包的命名格式采用utn.xxx开头
+  所有包的命名必须以utn.xxx开头，xxx代表项目或产品的简称。
 #### 5.4 常量、静态变量名采用全大写的方式，每个单词间用下划线分隔
+  这里的常量一般指类里用final static 修饰的成员变量。
 #### 5.5 变量名和方法名第一个单词的首字母小写，其余每个单词的首字母大写，首字母以外的字母全部小写
+  对于首字母缩写词如HTTP，把它同普通单词一样处理即仅有第一个H大写，其余字母小写。
+
 ### 6 注释
 #### 6.1 确保注释是完善你的代码而不是重复它
+  注释不应该包含代码本身显而易见的信息，而应该给出其他有用的信息。不仅要说明程序作了什么，还应该说明原因。
 #### 6.2 用中文或者英文注释代码
+  如果我们使用的开发平台支持中文，则尽可能的使用中文；否则使用流利的英语。
 #### 6.3 注释用词要精确，不能有二义性
+  人与人交流最大的问题就是误解。你以为他们看懂了你的注释或者他们认为自己看懂了你的注释，实际上往往并非如此，所以对于注释要和代码一样的进行审查。
 #### 6.4 注释中的术语要通用
 #### 6.5 注释应该和代码同步更新
 #### 6.6 禁止使用行尾注释
+  禁止采用行尾注释方法
+
+```
+int timeLength;    //表示经历时间的长度
+```
+  使用以下的注释方法
+
+```
+//表示经历时间的长度
+int timeLength; 
+或者这个变量非常重要，可以使用文档注释：
+/**
+ * 表示经历时间的长度
+ */
+int timeLength；
+```
+
 #### 6.7 注释不要嵌套
 #### 6.8 使用文档注释
+  如果你使用Java语言编程，你必须使用Javadoc的文档格式进行注释，以便以后用javadoc生成相应的文档。
+
+  必须使用文档注释的地方有：文件头注释、类定义注释、方法注释、方法或者类内部重要的变量。
+
 #### 6.9 文件头注释
+  使用Java编程的时候，在每个源程序文件的头部进行如下的注释：
+
+```
+/**
+ * @author Tom
+ * @version 1.0 2002/10/28
+ *
+ * Copyright (C) 2000, 2002, KOAL, Inc.
+ *
+ */
+```
+  注意文件头注释为javadoc的文档注释类型，下面的方法、类和结构的注释也是使用javadoc的文档注释类型。
+
+  如果注释的内容超过一行，缩进也是四个空格。
+
+  在整个文件头注释结束后至少留两个空行。
+
+  注意版权一行，前一个时间是文件产生的年份，后一个是最后修改的年份。 
+
+  上面的示例列出的是最少的注释内容，如果有别的内容，只要有必要，就可以添加在注释中，但一定要保证注释的排版清楚，不会造成阅读上的不便。下面的方法注释、类注释也可以是同样处理。
+
 #### 6.10 方法注释
+  使用Java编程的时候，每一个方法开头要有如下的注释：
+
+```
+/**
+ * <func-name>：<对方法的简单描述>
+ *
+ * @param <方法参数> <对方法参数的简单描述>
+ * @return <方法的返回值> <对返回值的简单描述>
+ * @throws <抛出的异常><抛出的异常的描述>
+ * 
+ * @see <参见的内容>
+ * @deprecated <删除的内容>
+ */
+```
+&emsp;&emsp;如果方法没有返回值，则这样书写：@return void，如果方法没有参数或者异常抛出，@param和@throws可以省略。@see和@deprecated标签只在必要的时候使用就可以了。
+
 #### 6.11 类注释
+&emsp;&emsp;使用Java编程的时候，每一个类开头要有如下的注释：
+
+```
+/**
+ * <class-type> <class-name>：<对这个类的简单描述>
+ *
+ * @see
+ * @deprecated
+ */
+```
+&emsp;&emsp;其中class-type说明这是个类， interface等，@see和@deprecated标签只在必要的时候使用就可以了。
+
 #### 6.12 方法或者类的内部注释
+&emsp;&emsp;在方法或者类的内部，可以不使用文档注释，对于非常重要的变量或者语句，可以使用文档注释，对于一般性的说明文字，使用普通的注释就可以了。
+
 #### 6.13 代码修改必须增加注释
+&emsp;&emsp;必须在修改的地方说明以下内容：
+* **1. 什么时间修改**
+* **2. 谁修改**
+* **3. 修改了什么内容**
+* **4. 到哪里为至**
+* **5. 修改后的版本号（产品版本或项目代码）**
+
+&emsp;&emsp;增加代码的注释方法:
+
+```
+…..
+//V1.3.1 2006-6-21 zhangsan 增加代码的原因 +{{
+增加的代码
+//}}
+```
+
+&emsp;&emsp;删除代码的注释方法:
+
+```
+…..
+/*V1.3.1 2006-6-21 zhangsan 删除代码的原因 -{{
+被删除的代码
+}}*/
+```
+
+&emsp;&emsp;修改代码的注释方法:
+```
+…..
+/*V1.3.1 2006-6-21 zhangsan 修改代码的原因 c{{
+被删除的代码
+*/
+新改动的代码
+//}}
+```
+
 ### 7 表达式
 #### 7.1 如果表达式中的运算符较多，使用括号确定运算顺序
 #### 7.2 避免大表达式中使用赋值语句