简体   繁体   English

Javadoc 不会在 IntelliJ IDEA 中自动生成

[英]Javadoc not auto-generating in IntelliJ IDEA

I'm having trouble with the file templates for Java Development in IntelliJ IDEA.我在处理 IntelliJ IDEA 中 Java 开发的文件模板时遇到问题。 I created an includes file to be parsed out and create Javadoc Comments from it.我创建了一个要解析的包含文件,并从中创建了 Javadoc 注释。

File > Settings > Editor > File and Code Templates > Includes Tab文件 > 设置 > 编辑器 > 文件和代码模板 > 包括选项卡

I added these variables to my File Header:我将这些变量添加到我的文件头中:

@name ${NAME}
@author #set( $Company = "Avaruus Studios" )
@date ${DATE}

文件和代码模板 - 包括选项卡

I then added the parse directive to the File Template:然后我将 parse 指令添加到文件模板中:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public class ${NAME} {
}

文件和代码模板 - 文件选项卡

When I add a new Java Class, the Javadoc Header Comments that are generated show up as errors:当我添加一个新的 Java 类时,生成的 Javadoc Header Comments 显示为错误:

新建 Java 类错误

How can I fix this template so that they are generated correctly?如何修复此模板以便正确生成它们?

Javadoc needs to be inside comment brackets for java, so try changing your template file to: Javadoc 需要在 Java 的注释括号内,因此请尝试将模板文件更改为:

Edit:编辑:

#set( $Company = "Avaruus Studios" )
/**
* @name ${NAME}
* @author ${Company}
* @date ${DATE}
*/

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM