ide javadoc配置

1、下载插件JavaDoc
2、找到项目下的 .idea目录,把如下3的代码覆盖到intellij-javadocs-4.0.1.xml。
在这里插入图片描述
3、配置内容

<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
  <component name="JavaDocConfiguration">
    <GENERAL>
      <MODE>UPDATE</MODE>
      <OVERRIDDEN_METHODS>false</OVERRIDDEN_METHODS>
      <SPLITTED_CLASS_NAME>true</SPLITTED_CLASS_NAME>
      <LEVELS>
        <LEVEL>METHOD</LEVEL>
        <LEVEL>TYPE</LEVEL>
        <LEVEL>FIELD</LEVEL>
      </LEVELS>
      <VISIBILITIES>
        <VISIBILITY>DEFAULT</VISIBILITY>
        <VISIBILITY>PROTECTED</VISIBILITY>
        <VISIBILITY>PUBLIC</VISIBILITY>
      </VISIBILITIES>
    </GENERAL>
    <TEMPLATES>
      <CLASSES>
        <CLASS>
          <KEY>^.*(public|protected|private)*.+interface\s+\w+.*</KEY>
          <VALUE>/**\n
                        * 描述该接口实现的功能\n
                        &lt;#if element.typeParameters?has_content&gt;&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt;                        * @param &lt;${typeParameter.name}&gt; 泛型参数\n
&lt;/#list&gt;                        *\n
                        * @since v1.0\n
                        * @author wangtao\n
                        * @date ${.now?string[&quot;yyyyMMdd HH:mm:ss&quot;]}\n
                        */</VALUE>
        </CLASS>
        <CLASS>
          <KEY>^.*(public|protected|private)*.+enum\s+\w+.*</KEY>
          <VALUE>/**\n
                        * 描述该枚举的用途\n
                        *\n
                        * @since v1.0\n
                        * @author wangtao\n
                        * @date ${.now?string[&quot;yyyyMMdd HH:mm:ss&quot;]}\n
                        */</VALUE>
        </CLASS>
        <CLASS>
          <KEY>^.*(public|protected|private)*.+class\s+\w+.*</KEY>
          <VALUE>/**\n
                        * 描述该类实现的功能\n
                        &lt;#if element.typeParameters?has_content&gt;&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt;                        * @param &lt;${typeParameter.name}&gt; 描述此泛型参数\n
&lt;/#list&gt;                        *\n
                        * @since v1.0\n
                        * @author wangtao\n
                        * @date ${.now?string[&quot;yyyyMMdd HH:mm:ss&quot;]}\n
                        */</VALUE>
        </CLASS>
        <CLASS>
          <KEY>.+</KEY>
          <VALUE>/**\n
                        * 描述该类实现的功能
                        *\n
                        * @since v1.0\n
                        * @author wangtao\n
                        * @date ${.now?string[&quot;yyyyMMdd HH:mm:ss&quot;]}\n
                        */</VALUE>
        </CLASS>
      </CLASSES>
      <CONSTRUCTORS>
        <CONSTRUCTOR>
          <KEY>.+</KEY>
          <VALUE>/**\n
                        * 描述该构造方法实现的功能\n
                        &lt;#if element.parameterList.parameters?has_content&gt;                        *\n
&lt;/#if&gt;&lt;#list element.parameterList.parameters as parameter&gt;                        * @param ${parameter.name} 描述此参数\n
&lt;/#list&gt;&lt;#if element.throwsList.referenceElements?has_content&gt;                        *\n
&lt;/#if&gt;&lt;#list element.throwsList.referenceElements as exception&gt;                        * @throws ${exception.referenceName} 抛出异常原因\n
&lt;/#list&gt;                        *\n
                        * @since v1.0\n
                        * @author wangtao\n
                        * @date ${.now?string[&quot;yyyyMMdd HH:mm:ss&quot;]}\n
                        */</VALUE>
        </CONSTRUCTOR>
      </CONSTRUCTORS>
      <METHODS>
        <METHOD>
          <KEY>^.*(public|protected|private)*\s*.*(\w(\s*&lt;.+&gt;)*)+\s+get\w+\s*\(.*\).+</KEY>
          <VALUE>/**\n
                        * 获取 ${partName}.\n
                        &lt;#if element.typeParameters?has_content&gt; * \n
&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt;                        * @param &lt;${typeParameter.name}&gt; 描述此泛型参数\n
&lt;/#list&gt;&lt;#if element.parameterList.parameters?has_content&gt;                        *\n
&lt;/#if&gt;&lt;#list element.parameterList.parameters as parameter&gt;                        * @param ${parameter.name} 描述此参数\n
&lt;/#list&gt;&lt;#if isNotVoid&gt;                        *\n
                        * @return 返回 ${partName}\n
&lt;/#if&gt;&lt;#if element.throwsList.referenceElements?has_content&gt;                        *\n
&lt;/#if&gt;&lt;#list element.throwsList.referenceElements as exception&gt;                        * @throws ${exception.referenceName} 描述抛出异常原因\n
&lt;/#list&gt;                        *\n
                        * @since v1.0\n
                        * @author wangtao\n
                        * @date ${.now?string[&quot;yyyyMMdd HH:mm:ss&quot;]}\n
                        */</VALUE>
        </METHOD>
        <METHOD>
          <KEY>^.*(public|protected|private)*\s*.*(void|\w(\s*&lt;.+&gt;)*)+\s+set\w+\s*\(.*\).+</KEY>
          <VALUE>/**\n
                        * Sets ${partName}.\n
                        &lt;#if element.typeParameters?has_content&gt; * \n
&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt;                        * @param &lt;${typeParameter.name}&gt; the type parameter\n
&lt;/#list&gt;&lt;#if element.parameterList.parameters?has_content&gt;                        *\n
&lt;/#if&gt;&lt;#list element.parameterList.parameters as parameter&gt;                        * @param ${parameter.name} the ${paramNames[parameter.name]}\n
&lt;/#list&gt;&lt;#if isNotVoid&gt;                        *\n
                        * @return the ${partName}\n
&lt;/#if&gt;&lt;#if element.throwsList.referenceElements?has_content&gt;                        *\n
&lt;/#if&gt;&lt;#list element.throwsList.referenceElements as exception&gt;                        * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n
&lt;/#list&gt;                        */</VALUE>
        </METHOD>
        <METHOD>
          <KEY>^.*((public\s+static)|(static\s+public))\s+void\s+main\s*\(\s*String\s*(\[\s*\]|\.\.\.)\s+\w+\s*\).+</KEY>
          <VALUE>/**\n
                        * 程序入口\n
                        &amp;lt;#if element.parameterList.parameters?has_content&amp;gt;
                        *\n
                        &amp;lt;/#if&amp;gt;
                        * @param ${element.parameterList.parameters[0].name} 描述此命令行参数\n
                        &amp;lt;#if element.throwsList.referenceElements?has_content&amp;gt;
                        *\n
                        &amp;lt;/#if&amp;gt;
                        &amp;lt;#list element.throwsList.referenceElements as exception&amp;gt;
                        * @throws ${exception.referenceName} 描述抛出异常原因\n
                        &amp;lt;/#list&amp;gt;
                        */</VALUE>
        </METHOD>
        <METHOD>
          <KEY>.+</KEY>
          <VALUE>/**\n
                        * 描述此方法实现的功能\n
                        &lt;#if element.typeParameters?has_content&gt;                        *\n
&lt;/#if&gt;&lt;#list element.typeParameters as typeParameter&gt;                        * @param &lt;${typeParameter.name}&gt; 描述此泛型参数\n
&lt;/#list&gt;&lt;#if element.parameterList.parameters?has_content&gt;                        *\n
&lt;/#if&gt;&lt;#list element.parameterList.parameters as parameter&gt;                        * @param ${parameter.name} 描述此参数\n
&lt;/#list&gt;&lt;#if isNotVoid&gt;                        *\n
                        * @return 返回 ${return} 描述此返回参数\n
&lt;/#if&gt;&lt;#if element.throwsList.referenceElements?has_content&gt;                        *\n
&lt;/#if&gt;&lt;#list element.throwsList.referenceElements as exception&gt;                        * @throws ${exception.referenceName} 描述抛出异常原因\n
&lt;/#list&gt;                        *\n
                        * @since v1.0\n
                        * @author wangtao\n
                        * @date ${.now?string[&quot;yyyyMMdd HH:mm:ss&quot;]}\n
                        */</VALUE>
        </METHOD>
      </METHODS>
      <FIELDS>
        <FIELD>
          <KEY>^.*(public|protected|private)*.+static.*(\w\s\w)+.+</KEY>
          <VALUE>/**\n
                        * ${element.getName()} 描述此常量\n
                        */</VALUE>
        </FIELD>
        <FIELD>
          <KEY>^.*(public|protected|private)*.*(\w\s\w)+.+</KEY>
          <VALUE>/**\n
                        &lt;#if element.parent.isInterface()&gt;                        *${element.getName()} 描述此常量\n
&lt;#else&gt;                        *${element.getName()} 描述此字段\n
                        &lt;/#if&gt; */</VALUE>
        </FIELD>
        <FIELD>
          <KEY>.+</KEY>
          <VALUE>/**\n
                        &lt;#if element.parent.isEnum()&gt;                        *${element.getName()} 描述此枚举常量\n
&lt;#else&gt;                        *${element.getName()} 描述此字段\n
                        &lt;/#if&gt;*/</VALUE>
        </FIELD>
      </FIELDS>
    </TEMPLATES>
  </component>
</project>

请注意:把以上作者wangtao改为你的名字;

配置注释模板

1、路径 File->Settings-> Live Templates
在这里插入图片描述
*在这里插入图片描述

date ->date()
params->groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n':'')}; return result", methodParameters()) 
return->methodReturnType()
 ==》配置说明,必须一模一样,否则后果自负~

*
 * 功能描述
 * @author wangtao 
 * @date $date$
$params$
 * @return $return$
 */

try

try {
    
} catch (Exception e) {
    log.error("Exception.is", e);
}
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Qing_wyt

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值