如何在Eclipse中如何自動添加註釋和自定義註釋風格

背景簡介

豐富的註釋和良好的代碼規範，對於代碼的閱讀性和可維護性起着相當重要的做用。幾乎每一個公司對這的要求仍是比較嚴格的，每每會造成本身的一套編碼規範。可是再實施過程當中，若是全靠手動完成，不只效率低下，還難以保證真正的符合規範。因此結合IDE環境，自動生成註釋，仍是頗有必要的。今天咱們就說一下，如何使用Eclipse給咱們提供的自定義代碼模版的功能來做業。

設置註釋模板

設置註釋模板的入口：Window->Preference->Java->Code Style->Code Template ，而後展開Comments節點就是全部需設置註釋的元素了！

接下來，對每個元素逐一介紹：

• 文件(Files)註釋標籤

Files標籤是對新建的文件的說明，出如今文件最上面

舉栗子：

/**   
 * Copyright © ${year} eSunny Info. Tech Ltd. All rights reserved.
 * 
 * @Package: ${package_name} 
 * @author: ${user}   
 * @date: ${date} ${time} 
 */複製代碼

• 類型(Types)註釋標籤（類的註釋）

Types標籤是對類Class的一個說明，出如今類上面

舉栗子：

/** 
 * @ClassName: ${type_name} 
 * @Description: ${todo}
 * @author: ${user}
 * @date: ${date} ${time} 
 * ${tags} 
 */複製代碼

• 字段(Fields)註釋標籤

Fields標籤是對變量字段的說明

舉栗子：

// @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)  複製代碼

• 構造函數(Constructors)標籤

Constructors標籤是對類的構造函數的說明

舉栗子：

/** 
 * @Title:${enclosing_type}
 * @Description:${todo} 
 * ${tags} 
 */  複製代碼

• 方法(Methods)標籤

Methods標籤是對函數方法的說明

舉栗子：

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo} 
* ${tags} ${return_type}
* @author ${user}
* @date ${date}${time}
*/ 複製代碼

• 覆蓋方法(Overriding Methods)標籤

Overriding Methods標籤是對覆蓋方法的說明

舉栗子：

/* (non Javadoc) 
 * @Title: ${enclosing_method}
 * @Description: ${todo}
 * ${tags} 
 * ${see_to_overridden} 
 */ 複製代碼

• 表明方法(Delegate Methods)標籤

舉栗子：

/**
 * ${tags}
 * ${see_to_target}
 */  複製代碼

• getter方法標籤

舉栗子：

/**  
* @return ${bare_field_name}  
*/  複製代碼

• setter方法標籤

舉栗子：

/**  
* @param ${param} 要設置的 ${bare_field_name}  
*/  複製代碼

以上標籤，只須要點擊右側面板上的按鈕 – 編輯(Edit)， 即可修改爲本身的註釋！

如何自動添加註釋

可經過以下三種方法自動添加註釋：
（1）輸入「/**」並回車。
（2）用快捷鍵 Alt＋Shift+J（先選中某個方法、類名或變量名）。
（3）在右鍵菜單中選擇「Source > Generate ElementComment」。

另外，新建文件或類的時候，怎麼自動生成文件(file)的註釋呢？

只須要勾選Automatically and comments for new methods and types便可！

導入/導出代碼格式模板

若是你辛辛苦苦定製好了本身的代碼風格，而後換了臺機器進行操做或重裝了Eclipse，是否是要從新配置一遍呢？答案固然是No了，Eclipse提供了「導出」和「導入」功能，你能夠把本身的模板導出來在其餘機器上使用。

建立自定義註釋模板

eclipse自帶一些註釋模板，如日期(@date)、文件名(@ClassName)、做者(@author)等，那麼怎麼自定義一些註釋模板呢？ codetemplates.xml模板內容，可直接導入eclipse

/**
* @Fields field:field:{todo}(用一句話描述這個變量表示什麼)
*//**
* MIT License
* Copyright (c) 2018 haihua.liu
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the 「Software」), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED 「AS IS」, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*//**
* @param paramtheparamthe{bare_field_name} to set
*//**
* @return ${bare_field_name}
*//**
* @ClassName: ${type_name}
* @Description: ${todo}(這裏用一句話描述這個類的做用)
* @author ${user}
* @date ${date}
*
* ${tags}
*//** (非 Javadoc)
*
*
* ${tags}
* ${see_to_overridden}
*//**
* ${tags}
* ${see_to_target}
*//**
* @Title: ${enclosing_method}
* @Description: ${todo}(這裏用一句話描述這個方法的做用)
* @param ${tags} 參數
* @return ${return_type} 返回類型
* @throws
*/ /**
* 建立一個新的實例 ${enclosing_type}.
*
* ${tags}
*/