Android studio的注释配置

Android Studio 按照下面的步奏配置：

Files-->Settings-->Editor-->File and Code Templates-->Includes

对类的注解

                                    /**   *    * 项目名称：${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 { }

javadoc文档输出注释的快捷按键

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[类、类#方法、类#成员]
*/
这样对函数的描述更加强大

eclipse中添加代码注释功能

例如： /** * @param * @return */ 快捷键为：ALT + SHIFT +J 想更换为其他的快捷键： Window-->Preferences-->General-->Keys;找到"add javadoc comment"更改自己喜欢的快捷键。另外如果觉得注释也不爽时也可以改改，修改的方法有两种： 1.直接在eclipse给的模板下进行修改 2.自己编写一个xml文档导入进去那就来先说说第一种方法吧：打开eclipse Window-->Preferences-->Java-->Code Style --> Code Templates --> Comments --> types --> Edit /** * * 项目名称：${project_name} * 类名称：${type_name} * 类描述： * 创建人：${user} * 创建时间：${date} ${time} * 修改人：${user} * 修改时间：${date} ${time} * 修改备注： * @version * */ 第二种方法是：点击右边的import按钮选择你写好的模板.xml文件下面是一个注释行模板codetemplates.xml，可以直接导入使用。贴出源码供大家参考一下 <?xml version="1.0" encoding="UTF-8"?> <templates>
<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="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>
<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"> /** * ${enclosing_method}(这里用一句话描述这个方法的作用) * TODO(这里描述这个方法适用条件 – 可选) * TODO(这里描述这个方法的执行流程 – 可选) * TODO(这里描述这个方法的使用方法 – 可选) * TODO(这里描述这个方法的注意事项 – 可选) * @param name * @param @return 设定文件 * @return String DOM对象 * @Exception 异常对象 * @since CodingExample　Ver(编码范例查看) 1.1 */ </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="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment"> /** * 文件名：${file_name} * * 版本信息： * 日期：${date} * Copyright 足下 Corporation ${year} * 版权所有 * */ </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"> /** * ${bare_field_name} * * @return the ${bare_field_name} * @since CodingExample Ver(编码范例查看) 1.0 */ </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"> /** * (non-Javadoc) * ${see_to_overridden} */ </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"> /** * ${field}:${todo}（用一句话描述这个变量表示什么） * * @since Ver 1.1 */ </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"> /** * * 项目名称：${project_name} * 类名称：${type_name} * 类描述： * 创建人：${user} * 创建时间：${date} ${time} * 修改人：${user} * 修改时间：${date} ${time} * 修改备注： * @version * */</template>
</templates> 有的时候导入会出现错误说无效的1字节UTF-8格式，解决办法，editplus打开该xml文件，另存为-选择encoding为UTF-8-确定-覆盖原文件，重新执行，终于成功了

android studio和 Eclipse中代码的注释，让你的代码更加