轉自:http://www.java265.com/JavaCourse/202111/1725.html
下文筆者講述java中注釋規范的相關說明，如下所示:
注釋形式統一
在整個團隊中，我們應該遵循同一種注釋規范，可通過設定注釋模板的方式，使用java注釋變得規范注釋的簡潔
通過注釋，可直接得到下面代碼的功能，為程式后續維護提供便利注釋的一致性
在撰寫代碼之前或同步進行代碼注釋的撰寫修改代碼時，也同時修改注釋
注釋的位置
使代碼同注釋相鄰，避免出現代碼和注釋無法對應，長年累月后都不知道注釋所對應的代碼注釋的數量
整個代碼中，注釋不宜過多，但也不能太少洗掉無用注釋
洗掉注釋中的臨時內容及無用的注釋資訊，避免后續維護時，給人誤導行為復雜的注釋
避免撰寫令人難以理解的注釋多余的注釋
當有些代碼非常清晰時，我們應該避免加入一些無關緊要的注釋資訊必加的注釋
如：一些實作子類中，演算法中，我們如果不加入注釋，則讓后人無法理解相應的代碼注釋不會增加檔案的大小
Java中的注釋檔案不會增加檔案的大小java注釋示例
檔案頭注釋
檔案頭注釋以/*開始，以*/結束，需要注明該檔案的創建時間、檔案名、命名空間資訊如：
/* Created on 2021-11-16
* File User.java
* Package com.Java265.other
* Create Date:2021-11-16
*/
類、介面注釋
類、介面的注釋采用/**...*/描述部分用來書寫該類的作用或者相關資訊，塊標記部分必須注明作者個版本
例：
/** Title：XXXX OCR
* Description:XXXX OCR 3.0
* Copyright:Copyright(c) 2021
* Company:XXXX 有限公司
*
* @author Adeal
* @version 3.0
*/
建構式注釋
建構式注釋采用/**...*/描述部分注明建構式的作用
/**
* 默認建構式
*/
帶塊標記的示例如下：
/**
* 帶引數建構式，初始化模式名、變數名稱和資料源型別
* @param schema
* Ref 模式名
* @param name
* Ref 變數名稱
* @param type
* by Val 資料源型別
*/
域注釋
域注釋可以出現在注釋檔案里面也可以不出現在注釋檔案里面
用/**...*/的域注釋將會被認為是注釋檔案而出現在最終生成的HTML報告里面（Javadoc）
而使用/*...*/的注釋則會被忽略掉
如：
/**
* @作者 XXX
* @創建時間 Jan 16,2021 05:05:11 AM
*/
方法注釋
方法注釋采用/**...*/描述部分注明方法的功能
塊標記部分注明方法的引數
回傳值，例外資訊
如:
/**
* 求最大公約數
*
* @param int a
* a:待求公約數的引數
*/
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/465955.html
標籤：Java
上一篇：10輪偽匹配