首先
/**
*
* 项目名称:${PROJECT_NAME}
* 类描述:
* 创建人:${USER}
* 创建时间:${DATE} ${TIME}
* 修改人:${USER}
* 修改时间:${DATE} ${TIME}
* 修改备注:
* @version
*
*/
上面的英文在studio必须是大写
这样在新建一个java类文件的时候,就会将自动生成Class Header中的内容,自动添加了你的注释模板中定义好了的注释,显示如下:
package contract.test.day01;
/**
* 项目名称:Day01
* 类描述:
* 创建人:wy
* 创建时间:2014/12/24 11:17
* 修改人:wy
* 修改时间:2014/12/24 11:17
* 修改备注:
*/
public class KKs {
}
android studio 添加javadoc文档输出注释的快捷按键
http://blog.csdn.net/hyr83960944/article/details/37696185
http://blog.csdn.net/maosidiaoxian/article/details/37030649
File->Settings,搜索keymap,点开Keymap,在右边面板上搜索,找到Other->Fix doc comment,双击,选择Add Keyboard Shortcut,按下你的快捷键。Eclipse中是alt + shift +J,但是在这里会冲突,所以我用了比较近的快捷键组合:alt + shift + K。在修改文档注释,如添加参数等方面,Android Studio的快捷键比Eclipse要智能多了。
选中你要修改快捷键的功能点,右键,就能弹出对话框了,对话框有4个选项,这里解释下4个选项:
Add Keyboard Shortcut:设置键盘快捷键
Add Mouse Shortcut:设置鼠标快捷键,比如鼠标左键,鼠标右键
Add Abbreviation:这个是添加一个简写
最后一个就是移除快捷键了。
关于修改快捷键这里还需要注意下:
比如我选了第一个,选中对话框,这个时候你要修改快捷键一定要注意,比如我要修改成Ctrl+Shift+Z,这个时候不是一个一个对应的按键按下去,你一定要把Ctrl,Shift,Z三个一起按下去,因为这边只默认识别单次输入。Add Mouse Shortcut也是类似的。
private void wy(int x, int y)
{
}
}
把鼠标放置在wy函数上面,按住你在Fix doc comment上面设置的快键按键,就会弹出注释:
/**
* @param x
* @param y
*/
private void wy(int x, int y)
{
}
}
如果你觉得函数体的参数简单:你如上面图所示新建一个Method Header
在里面加入下面代码:
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @param [参数1] [参数1说明]
* @param [参数2] [参数2说明]
* @return [返回类型说明]
* @exception/throws [违例类型] [违例说明]
* @see [类、类#方法、类#成员]
*/
这样对函数的描述更加强大
下面是我的配置
/**
* @Date:${DATE} ${TIME}
* @Author: ${USER}
* @类描述:
*/
自定义注释
/** * @Date:$Date$ $Time$ * @Author: $author$ * @类描述: */