Eclipse中用于CodeTemplate的变量总结

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

在Window→Preferences菜单里，找到Java语言的CodeTemplates界面。

CodeTemplates分为Comments和Code两类，选中一条后点击Edit按钮可以编辑这个模版。

在这里可以看到【InsertVariable】按钮。在这里列出了CodeTemplate中可以使用到的变量。

在Java中的对应位置，输入/**三个字符，再按下回车键，就可以自动生成CodeTemplate中指定的模式了。

下面是对其中变量的逐一说明：

CodeTemplate中的变量，都用美元符号后面的花括号围住，如${date}、${time}等，如果要在CodeTemplate中要写美元符号$，则用两个美元符号连写表示。

下面逐一解释一下这些变量的含义：

1、${year}，代表当前年份，例如：2015

2、${date}，代表当前日期，例如：2015年11月29日

3、${time}，代表当前时间，例如：下午10:07:15

4、${project_name}，代表项目名，如果项目如上图所示，则该变量值为：VariableTest

5、${package_name}，代表包名，如果项目如上图所示，则该变量值为：varTest

6、${file_name}，代表当前文件名，如果项目如上图所示，则该变量值为：VarTest.java

7、${type_name}，代表当前类名，例如：VarTest

8、${enclosing_type}，如果类A是在另一个类B内部声明的，则该变量记录了类B的名字，否则为空，代码举例如下：

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

9、${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
 */

10、${todo}，有这个变量的位置，会生成一个TODO标签

11、${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

转载于:https://my.oschina.net/Tsybius2014/blog/537167