美文网首页
Android代码注释模版

Android代码注释模版

作者: 郝赫 | 来源:发表于2017-03-08 12:11 被阅读117次

    Android代码注释模版

    一、注释模版的内容 代码注释生成文档,所以,部分注释内容需要用到html标签排版内容以达到代码美观的目的,常用的

    有等,Android studio 在 file菜单中选择settings 搜索File and Code Templates,在右侧菜单中选择不同的代码使用场景并编辑为需要的模版,在生成注释时就可以生成自己想要的注释

    二、注释代码脚本编写

    生成代码模版时,需要用到默认的生成内容,例如,将@author的默认内容设定为自己的用户名,方法一、直接配置内容 或者配置内容为 USERNAME时间为{DATE} 、YEAR、{ORGANIZATION_NAME}

    三、通用注释模版

    1.文件(Files)注释标签:

    /**

    * All rights Reserved, Designed By Android_Robot

    * @Title: filename∗@Package{package_name}

    * @Description: todo(用一句话描述该文件做什么)∗@author:AndroidRobot∗@date:{date} ${time}

    * @version V1.0

    */

    2.类型(Types)注释标签(类的注释):

    /**

    * @ClassName: typename∗@Description:{todo}(这里用一句话描述这个类的作用)

    * @author: Android_Robot

    * @date: date{time}

    *

    * ${tags}

    */

    3.字段(Fields)注释标签:

    /**

    * @Fields field:{todo}(用一句话描述这个变量表示什么)

    */

    4.构造函数标签:

    /**

    * @Title: enclosingtype∗@Description:{todo}(这里用一句话描述这个方法的作用)

    * @param: ${tags}

    * @throws

    */

    5.方法(Methods)标签:

    /**

    * @Title: enclosingmethod∗@Description:{todo}(这里用一句话描述这个方法的作用)

    * @param: tags∗@return:{return_type}

    * @throws

    */

    6.覆盖方法(Overriding Methods)标签:

    /**

    *

    Title: ${enclosing_method}

    *

    Description:

    * tags∗{see_to_overridden}

    */

    7.代表方法(Delegate Methods)标签:

    /**

    * tags∗{see_to_target}

    */

    8.getter方法标签:

    /**

    * @Title: enclosingmethod∗@Description:pleasewriteyourdescription∗@return:{field_type}

    */

    9.setter方法标签:

    /**

    * @Title: enclosingmethod∗@Description:pleasewriteyourdescription∗@return:{field_type}

    */

    相关文章

      网友评论

          本文标题:Android代码注释模版

          本文链接:https://www.haomeiwen.com/subject/jjqmtttx.html