Eclipse註釋模板設置詳解

前言：上一篇文章《Eclipse添加註釋簡介》給你們簡單介紹了一下在註釋的相關設置，本文將會進一步講解有關注釋的內容。
設置註釋模板的入口：Window->Preference->Java->Code Style->Code Template 而後展開Comments節點就是全部需設置註釋的元素。本文現就每個元素逐一給你們介紹一下。
文件(Files)註釋標籤：

1 2 3 4 5 6 7 8

/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句話描述該文件作什麼) * @author ${user} * @date ${date} * @version V1.0 */

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

1 2 3 4 5 6 7 8

/** * @ClassName: ${type_name} * @Description: ${todo}(這裏用一句話描述這個類的做用) * @author ${user} * @date ${date} * * ${tags} */

字段(Fields)註釋標籤：

1 2 3

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

構造函數(Constructor)標籤：

1 2 3 4 5

/** * 建立一個新的實例 ${enclosing_type}. * * ${tags} */

方法(Methods)標籤：

1 2 3 4 5 6 7

/** * @Title: ${enclosing_method} * @Description: ${todo}(這裏用一句話描述這個方法的做用) * @param ${tags}    參數 * @return ${return_type}    返回類型 * @throws */

覆蓋方法(Overriding Methods)標籤：

1 2 3 4 5 6

/* (非 Javadoc) * <p>Title: ${enclosing_method}</p> * <p>Description: </p> * ${tags} * ${see_to_overridden} */

代理方法(Delegate Methods)標籤：

1 2 3 4

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

getter方法標籤：

1 2 3

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

setter方法標籤：

1 2 3

/** * @param ${param} the ${bare_field_name} to set */

要實現上面的註釋模板，這須要將下面的配置文件導入就能夠了：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131

<? xml version = "1.0" encoding = "UTF-8" ?> < templates >      < template                  autoinsert = "false"                  context = "filecomment_context"                  deleted = "false"                  description = "Comment for created Java files"                  enabled = "true"                  id = "org.eclipse.jdt.ui.text.codetemplates.filecomment"                  name = "filecomment" >      /**       * @Title: ${file_name}     * @Package ${package_name}     * @Description: ${todo}(用一句話描述該文件作什麼)     * @author ${user}     * @date ${date}     * @version V1.0       */      < / template >      < template                  autoinsert = "false"                  context = "typecomment_context"                  deleted = "false"                  description = "Comment for created types"                  enabled = "true"                  id = "org.eclipse.jdt.ui.text.codetemplates.typecomment"                  name = "typecomment" >      /**     * @ClassName: ${type_name}     * @Description: ${todo}(這裏用一句話描述這個類的做用)     * @author ${user}     * @date ${date}     *     * ${tags}     */      < / template >      < template                  autoinsert = "false"                  context = "fieldcomment_context"                  deleted = "false"                  description = "Comment for fields"                  enabled = "true"                  id = "org.eclipse.jdt.ui.text.codetemplates.fieldcomment"                  name = "fieldcomment" >      /**     * @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)     */      < / template >      < template                  autoinsert = "false"                    context = "constructorcomment_context"                  deleted = "false"                  description = "Comment for created constructors"                  enabled = "true"                  id = "org.eclipse.jdt.ui.text.codetemplates.constructorcomment"                  name = "constructorcomment" >      /**      * 建立一個新的實例 ${enclosing_type}.      *      * ${tags}      */      < / template >          < template                  autoinsert = "false"                  context = "methodcomment_context"                  deleted = "false"                  description = "Comment for non-overriding methods"                  enabled = "true"                  id = "org.eclipse.jdt.ui.text.codetemplates.methodcomment"                  name = "methodcomment" >      /**     * @Title: ${enclosing_method}     * @Description: ${todo}(這裏用一句話描述這個方法的做用)     * @param ${tags}    參數     * @return ${return_type}    返回類型     * @throws     */      < / template >      < template                  autoinsert = "true"                  context = "overridecomment_context"                  deleted = "false"                  description = "Comment for overriding methods"                  enabled = "true"                  id = "org.eclipse.jdt.ui.text.codetemplates.overridecomment"                  name = "overridecomment" >      /* (非 Javadoc)     * <p>Title: ${enclosing_method}</p>     * <p>Description: </p>     * ${tags}     * ${see_to_overridden}     */      < / template >          < template                  autoinsert = "true"                  context = "delegatecomment_context"                  deleted = "false"                  description = "Comment for delegate methods"                  enabled = "true"                  id = "org.eclipse.jdt.ui.text.codetemplates.delegatecomment"                  name = "delegatecomment" >      /**      * ${tags}      * ${see_to_target}      */      < / template >      < template                  autoinsert = "false"                  context = "gettercomment_context"                  deleted = "false"                  description = "Comment for getter method"                  enabled = "true"                  id = "org.eclipse.jdt.ui.text.codetemplates.gettercomment"                  name = "gettercomment" >      /**     * @return ${bare_field_name}     */      < / template >      < template                  autoinsert = "true"                  context = "settercomment_context"                  deleted = "false"                  description = "Comment for setter method"                  enabled = "true"                  id = "org.eclipse.jdt.ui.text.codetemplates.settercomment"                  name = "settercomment" >      /**      * @param ${param} the ${bare_field_name} to set      */      < / template > < / templates >

聲明: 本文由金絲燕網原創編譯，轉載請保留連接: Eclipse註釋模板設置詳解