JAVA代碼註釋規範
一、 規範存在的意義
1. 好的註釋規範可以讓人一眼看明白這是幹什麼的，特別是對於我們這種行業；共同合作完成一個項目需要分工明確，所以也需要有明瞭的註釋規範。
2. 正確的應用註釋規範可以增加代碼的可讀性、理解性。
3. 好的代碼規範可以提高團隊的開發效率，從而節省時間。
4. 長期的堅持代碼規範可以讓程序員養成一個良好的習慣，甚至鍛煉出思維。
二、 命名規範
1. 一般概念
1) 儘量使用完整的英文描述。
2) 採用相對好理解的術語。
3) 採用駱駝命名的規範使名字增加可讀性。
4) 儘量少用縮寫提高可讀性。
5) 避免名字過長。
6) 避免使用類似的名字。
7) 避免使用特殊符號。
2. 主要的運用
1) 類（class）的命名
2) 接口(interface)的命名
+方法(method)的命名
3) 參數(param)的命名
三、 註釋規範
1. 一般概念
1) 註釋應該增加代碼的清晰度
2) 保持代碼的整潔
3) 在寫代碼之前或同時注意寫上註釋
4) 註釋出爲什麼做這件事，做這件事的結果
2. 註釋那些部分
1) java文件：版權信息、創建時間、創建人
2) 類：目的、所完成功能、版權信息、創建人
3) 方法：參數含義、返回值
4) 屬性：字段描述
5) 接口：目的、創建人、版本號、創建時間
四、 代碼格式規範
1. 單行註釋://註釋內容，一般與代碼後空4-8格，註釋必須對齊
2. 塊狀註釋：/*註釋內容*/，一般是註釋從以/*開始，以*/結束中的所有內容。
3. 文檔註釋：/**......*/所以註釋文 檔必須書寫在類、域、構造函數、方法，以及字段(field)定義之前. 註釋文檔由兩部分組成——描述、塊標記。
4. javadoc註釋標籤
@author 對類的說明 標明開發該類模塊的作者
@version 對類的說明 標明該類模塊的版本
@see 對類、屬性、方法的說明 參考轉向，也就是相關主題
@param 對方法的說明 對方法中某參數的說明
@return 對方法的說明 對方法返回值的說明
@exception 對方法的說明 對方法可能拋出的異常進行說明
五、java註釋具體實現
1. 源文件註釋
/**
*文件名
*創建人
*創建時間
*修改人
*描述
*版本號
*/
2. 類註釋
/**
*對此類的描述信息
*創建人
*版本號
*創建時間
*/
3. 方法的註釋
/**
*方法的用處
*該方法的參數列
*該方法返回的值
*/
4. 屬性的註釋
/**
*字段的描述
*/
5. 接口註釋
/**
*對此接口的描述
*創建人
*創建時間
*版本號
*/
6. 構造方法註釋
/**
*描述該構造方法的用處
*該構造方法的參數列
*參數的類型
*/
六、Jsp代碼格式規範
1. 多行註釋:<!-- 註釋內容 -->,一般是註釋從以<!-- 開始，以-->結束中的所有內容。
2. 文本註釋:<%-- 內容 --%>,主要是對該頁面的一些描述，目的、創建人、創建時間、版本號、文件名、備註、修改人等.
例如:
<%--
-創建人
-創建時間
-版本號
-文件名
-備註
-修改人
--%>
3. 僞劣標籤註釋:<% java語句塊 %>
例如：
<%
JAVA代碼塊
%>
4. 單行註釋：//註釋內容，一般與代碼後空4-8格，註釋必須對齊
七、JS代碼格式規範
1. 文本註釋:/** 註釋內容**/，主要是對該頁面的一些描述，目的、創建人、創建時間、版本號、文件名、備註、修改人等. 也可以用於註釋代碼塊。
例如:
/**
*創建人
*創建時間
*版本號
*文件名
*備註
*修改人
**/
2. 文本註釋:/** 內容 */ ,主要是對該頁面的一些描述，目的、創建人、創建時間、版本號、文件名、備註、修改人等.也可以用於註釋代碼塊。
例如:
/**
*創建人
*創建時間
*版本號
*文件名
*備註
*修改人
*/
3. 單行註釋: //註釋內容，一般與代碼後空4-8格，註釋必須對齊
4. 多行註釋: /* 註釋內容 */,一般是註釋從以/* 開始，以*/結束中的所有內容。
八、JS註釋具體實現
1. 文件註釋
/**
*對此文件的描述信息
*創建人
*版本號
*創建時間
*/
2. 方法的註釋
/**
*方法的用處
*該方法的參數列
*該方法返回的值
*/
3. 模塊的註釋
/**
*模塊名稱
*模塊的用處
*/