zoukankan      html  css  js  c++  java
  • 在IDEA中生成类注释及注释文档

    在IDEA中生成类注释及注释文档

    生成类注释

    打开IDEA,点击File-->Setting-->Editor-->File and Code Templates-->Class,然后加入

    /**
     * <h3>${PROJECT_NAME}</h3>										//项目名称
     *
     * @author:Xuda													//作者
     * @date:${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:${SECOND}	//创建时间
     * @description:${description}									//描述
     */
    

    在public class ${name}{}之前,如下图:

    注释

    效果图:

    效果图

    模板信息有很多如:

    ​ ${PROJECT_NAME} 项目名称

    ​ ${NAME} 新创建的类名

    ​ ${USER} 系统用户名

    ​ ${description} 描述

    ​ ${date} 新创建的日期

    ​ ${TIME} 新创建的时间 ...

    注意:当我们编写好,一点要先点击Apply再点击OK。当我们加了@description后,在我们新建类时,写后类名后,会再弹出描述类的框框,如下:

    描述

    这里可以编写中英文。

    生成注释文档

    打开cmd命令行,并切到当前文夹下,这里我建议在IDEA中直接鼠标有右键,找到Show in Explorer,鼠标左键单击

    Show

    打开当前类所在的文件夹,再通过在路径直接输入cmd,进入命令行

    进入命令行

    然后在命令行输入javadoc -encoding UTF-8 -charset UTF-8 -author test.java即可,这里的-encoding UTF-8 -charset UTF-8是为了防止中文注释乱码,-author是读取作者。

    最后在该类的文件夹下打开index.html即可

    刚刚参加工作,很有很多不懂不会的,发现错误,欢迎指正,谢谢!
  • 相关阅读:
    swift 上的 lazy
    oc runtime
    iOS布局
    ios微信支付 v3
    好用的工具
    自己曾经没注意的东西
    根据文字计算出label的高度
    项目swift的一些问题
    UIAppearance
    书签
  • 原文地址:https://www.cnblogs.com/xd-study/p/12834905.html
Copyright © 2011-2022 走看看