Eclipse中用於CodeTemplate的變量總結

今天研究了一下Eclipse中用於CodeTemplate功能的變量。

在Window→Preferences菜單裏，找到Java語言的CodeTemplates界面。

CodeTemplates分爲Comments和Code兩類，選中一條後點擊Edit按鈕能夠編輯這個模版。

在這裏能夠看到【InsertVariable】按鈕。在這裏列出了CodeTemplate中可使用到的變量。

在Java中的對應位置，輸入/**三個字符，再按下回車鍵，就能夠自動生成CodeTemplate中指定的模式了。

下面是對其中變量的逐一說明：

CodeTemplate中的變量，都用美圓符號後面的花括號圍住，如${date}、${time}等，若是要在CodeTemplate中要寫美圓符號$，則用兩個美圓符號連寫表示。

下面逐一解釋一下這些變量的含義：

一、${year}，表明當前年份，例如：2015

二、${date}，表明當前日期，例如：2015年11月29日

三、${time}，表明當前時間，例如：下午10:07:15

四、${project_name}，表明項目名，若是項目如上圖所示，則該變量值爲：VariableTest

五、${package_name}，表明包名，若是項目如上圖所示，則該變量值爲：varTest

六、${file_name}，表明當前文件名，若是項目如上圖所示，則該變量值爲：VarTest.java

七、${type_name}，表明當前類名，例如：VarTest

八、${enclosing_type}，若是類A是在另外一個類B內部聲明的，則該變量記錄了類B的名字，不然爲空，代碼舉例以下：

/**
 * @enclosing_type
 */
public class VarTest {
    /**
     * @enclosing_type VarTest
     */
    public class VarTest2 {
        /**
         * @enclosing_type VarTest.VarTest2
         */
        public class VarTest3 {
            
        }
    }
}

九、${tags}，輸出函數的輸入參數與返回值，例若有函數聲明以下：

public int func(int a, String b, long c, boolean d) {
    return 0;
}

CodeTemplate的Pattern以下：

/**
 * ${tags}
 */

則生成的註釋以下：

/**
 * 
 * @param a
 * @param b
 * @param c
 * @param d
 * @return
 */

十、${todo}，有這個變量的位置，會生成一個TODO標籤

十一、${user}，這個變量存儲了當前Eclipse的用戶名，這個用戶名能夠在eclipse.ini中設置。

在最後添加一行

-Duser.name=Tsybius2014

其中Tsybius2014能夠換成任意本身但願取的名字，修改位置以下圖所示：

以類爲例，將Comment下的Type的Pattern設置成這樣

/**
 * @author ${user}
 * @date ${date}
 * @time ${time}
 * @remark
 *
 * ${tags}
 */

這樣輸出的註釋就會是：

/**
 * 
 * @author Tsybius2014
 * @date 2015年11月29日
 * @time 下午10:40:35
 * @remark
 *
 */
public class VarTest {
    // ...
}

其中 @ author 後面的文字，就是咱們剛纔設定的內容

END