1. 程式人生 > >在Eclipse中設定自動生成javadoc註釋

在Eclipse中設定自動生成javadoc註釋

轉自:http://jingyan.baidu.com/article/a501d80c09dab1ec620f5e4b.html

http://www.cnblogs.com/fsjohnhuang/p/3988883.html

windows-->preference-->Java-->Code Style-->Code Templates-->code-->new Java file

例如在new java file中編輯模版如下:

${filecomment}${package_declaration}
/** 
* @author : suyuyuan
* @date 建立時間:${date} ${time} 
* @version 1.0 
* @parameter  
* @since  
* @return  
*/
${typecomment}${type_declaration}

新建class類時就會出現如下效果:

package com.suyuyuan.demo.common;
/** 
* @author : suyuyuan
* @date 建立時間:2016年3月15日 下午5:40:45 
* @version 1.0 
* @parameter  
* @since  
* @return  
*/
public class Test {


}

再如:

${filecomment}
${package_declaration}
/**  

* @ClassName: ${type_name}
* @Description: ${todo}
* @author suyuyuan
* @date ${date} ${time}
*
*/
${typecomment}
${type_declaration}

樣式如下:

package Util;
/**  

* @ClassName: Test
* @Description: TODO
* @author suyuyuan
* @date 2016年10月10日 上午10:08:45
*
*/
public class Test{


}

-------------------分割線------------------------

以下是如何給java類中的方法自動添加註釋:

windows-->preference-->Java-->Code Style-->Code Templates-->Comments-->Methods-->Edit

編輯輸入:

/**

 * 
 *
 *  ${tags} ${return_type}
 */

儲存即可。

在使用時,雙擊想要添加註釋的方法,按下組合快捷鍵:Alt+Shift+J,即可。

---------------分割線--------------------

一、註釋                                  

  1. 註釋型別

     [a]. 單行註釋

// 單行註釋
String type = "單行註釋";

     [b]. 多行註釋

/* 
 * 多行註釋
 */
String type = "多行註釋";

     [c]. 文件註釋

/**
 * 文件註釋
 */
public class Dummy{}

  2. 快捷鍵

     [a]. 新增/取消單行註釋: Ctrl+/ 

     [b]. 新增類的文件註釋: Ctrl+Shift+j 

二、註釋模板                                

  作用:定義檔案、類和方法等預設的註釋格式,減少手工輸入的工作量。

  1. 設定註釋模板的入口:點選 Window->Preference->Java->Code Style->Code Template ,然後展開 Comments節點 。

  2. Comments節點 下的元素介紹:

     File節點(檔案註釋標籤)

複製程式碼
/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句話描述該檔案做什麼) 
* @author fsjohnhuang
* @date ${date} ${time} 
* @version V1.0   
*/
複製程式碼

     Types節點(類註釋標籤)

複製程式碼
/** 
* @ClassName: ${type_name} 
* @Description: ${todo}(這裡用一句話描述這個類的作用) 
* @author fsjohnhuang
* @date ${date} ${time} 
* 
* ${tags} 
*/
複製程式碼

      Fields節點(欄位註釋標籤)

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

     Constructor節點(建構函式註釋標籤)

/** 
* <p>Title: </p> 
* <p>Description: </p> 
* ${tags} 
*/

     Method節點(方法註釋標籤)

複製程式碼
/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(這裡用一句話描述這個方法的作用) 
* @param ${tags}  引數說明 
* @return ${return_type}    返回型別 
* @throws 
*/
複製程式碼

     Overriding Methods節點(覆蓋方法註釋標籤)

/*
* Title: ${enclosing_method}
*Description: 
* ${tags} 
* ${see_to_overridden} 
*/

    Delegate Methods節點(代理方法註釋標籤)

/** 
* ${tags} 
* ${see_to_target} 
*/ 

    getter節點(getter方法註釋標籤)

/** 
* @return ${bare_field_name} 
*/

    setter節點(setter方法註釋標籤)

/** 
* @param ${param} 要設定的 ${bare_field_name} 
*/

  3. 匯入、匯出註釋模板

    在 Window->Preference->Java->Code Style->Code Template 下可匯入匯出註釋模板。


相關推薦

Eclipse設定自動生成javadoc註釋

轉自:http://jingyan.baidu.com/article/a501d80c09dab1ec620f5e4b.html http://www.cnblogs.com/fsjohnhuang/p/3988883.html windows-->preferen

Eclipse設置自動生成javadoc註釋

eth ram ref pos 分享圖片 pes ron bubuko methods 1)windows-->preference-->Java-->Code Style-->Code Templates-->code-->new Ja

eclipse如何自動生成構造函數

技術 tor get src sin image super java 構造函數 eclipse中如何自動生成構造函數 eclipse是一個非常好的IDE,我在寫java程序的時候使用eclipse感覺開發效率很高。而且有很多的快捷和簡便方式供大家使用,並且能直接生成cla

Eclipsemybatis自動生成程式碼

工具下載 Eclipse中help–>install new software 如下圖所示 Location:內容 完成安裝之後,選擇新建–Ctrl + N之後,生成generateConfig.xml檔案 GenerateConfig.xm

EclipseMybatis自動生成外掛使用

       對於使用Mybatis的開發者來說, 使用mybatis generator來生成mapper 以及配置檔案, 可以大大簡化工作, mybatis generator有多種工作方式, eclipse外掛是一種比較友好的方式. 第一, 首先,到http://ma

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

背景簡介 豐富的註釋和良好的程式碼規範,對於程式碼的閱讀性和可維護性起著至關重要的作用。幾乎每個公司對這的要求還是比較嚴格的,往往會形成自己的一套編碼規範。但是再實施過程中,如果全靠手動完成,不僅效率低下,還難以保證真正的符合規範。所以結合IDE環境,自動

eclipse自動生成getset註釋

setters ron ren 目錄 pla 設置 附件 註釋 consola 1、文件替換 將附件裏的文檔替換到eclipse安裝目錄下的plugins,在替換之前最好是把那個文件做個備份放在外面。 2、重啟Eclipse設置註釋風格: Window->Prefer

eclipse設定編碼自動補全功能

如果你用過Visual Studio的自動補全功能後,再來用eclipse的自動補全功能,相信大家會有些許失望。 但是eclipse其實是非常強大的,eclipse的自動補全沒有VS那麼好是因為eclipse的補全功能用的是預設設定。你只需要稍微修改一下就行了。 最簡單的修改方式是:Wi

eclipse設定輸入程式碼自動提示功能

開啟選單欄下的window,選擇最下方的preference 如圖選擇,java下的editor,點選content assist 選項如圖選擇,在auto activation triggers for java中新增.abcdefghijklmnopqrstuvwxy

Eclipse設定XML檔案的自動格式化配

  在Eclipse下編輯XML檔案時可以像Java檔案一樣進行格式化。不過,預設的格式化設定效果不太理想,尤其是標籤屬性較多時。   通過以下設定可以達到一個相對理想的效果:   Window -> Preferences -> XML ->XML Fi

Eclipse設定XML檔案的自動格式化配置

設定XML檔案的自動格式化配置:      在Eclipse下編輯XML檔案時可以像Java檔案一樣進行格式化。不過,預設的格式化設定效果不太理想,尤其是標籤屬性較多時。 通過以下設定可以達到一個相對理想的效果: Window -> Preferences ->

Eclipse自動生成javadoc

javadoc The JDK tool that generates API documentation from documentation comments. Docum

eclipse如何為生成的get/set方法添加註釋

我需要這樣的get/set方法 /** * 獲取起始頁 * * @return the startIndex */ public int getStartIndex() { return startIndex; } /** * 設定起始頁

eclipse設定註釋模板

參考:http://www.cnblogs.com/duboway/archive/2013/04/11/Eclipse.html注意類的註釋模板是修改Types而不是Files,這個很多地方都寫錯了。

Eclipse 通過JPA自動生成註解實體

tools nts 完成 oracl orm pro 技術 nbsp 問題 hibernate是JPA最常用的實現之一,而且hiberante自身也對註釋語法進行了支持。現在再不用去看那一堆堆的XML映射了。而且eclipse還提供了從數據庫直接生成Entity Clas

Eclipse 添加文檔註釋快捷鍵

導入 ces -- nts 模板 ext type alt false 例如:/** * @param * @return */快捷鍵為:ALT + SHIFT +J想更換為其他的快捷鍵:Window-->Preferences-->General--

eclipse插件自動生成類圖

直接 network projects TP ble 文件拷貝 用法 com eclipse 安裝和使用AmaterasUML, 安裝AmaterasUML前,需要先安裝GEF。采用eclipse在線安裝方式安裝就好: 在window ==》preferences ==》

Eclipse如果自動啟動TOMCATSgU

人在 一半 人的一生 綠色 女性 人生 很慢 為我 只有一個 <p>  我很笨, 所以總是聽不懂別人的意向; 我很懶, 所以總是不願去計較許多事!情; 我很慢, 所以總是延誤時間; 我很悲觀, 所以總是自認為不如人。 誰曾想,我的心裏很害怕這些, 我逃,我躲,可

fileheader-vscode外掛,自動生成頭部註釋 koroFileHeader

給使用vscode的開發的小夥伴分享一個自動生成頭部註釋的外掛,使用效果如下:    生成這個註釋的快捷鍵是 ctrl+alt+i    1.安裝 在vs商店搜尋koroFileHeader &nbs

vim括號自動生成

https://blog.oldj.net/2011/06/17/vim-parenthesis/ set smartindent set tabstop=4 set shiftwidth=4 set expandtab "括號自動補全,用了兩種形式請區分清除 inoremap ' '