Android Studio可以添加文档注释模板,方便我们在想写注释的地方快速便捷地生成文档注释模板。
步骤
- 菜单栏File–>Settings–>Editor–>Live Templates;
- 点击右侧的+号,创建一个Template Group:
- 填写创建的group名,比如MyGroup,点击OK;
- 选中刚才创建的Group,再点+号,这次选择Live Template:
填写编辑以下内容:
Abbreviation:注释模板的缩写,你可以按照类名、方法名、变量名的规则去命名;
Description:注释模板的简短描述;
Template text:模板的内容;
Edit variables:编辑模板中用到的变量;
在最下面的红色方框处选择该模板在何处可用。 - Edit variables
模板中包含变量时,比如上图中的$date$ $time$
,点击右边的Edit variables按钮可以为这些变量选定表达式(Expression),这样在代码中使用该模板生成注释时会自动用表达式的值替换变量。
选定之后点击OK即可。 - 选择在何处使用注释模板
在步骤4里最下面的红色方框处选择,新编辑的模板在这里是一个可以点击的Define单词。我选的是在java代码中的Declaration处,即在需要生成注释的地方打出刚才命名的Abbreviation,比如我的是classa,然后回车,即可生成注释。
选定之后点击Apply和OK就完成了注释模板的添加,已经可以在代码中使用。
其他的注释模板比如方法注释、字段注释等都是同样的道理。下面附上一张效果图: