在IDEA中,如何为新类型生成javadoc?

时间:2018-12-29 08:34:39

标签: java intellij-idea javadoc

在Eclipse中,使用新类型的alt + shift + J将生成带有作者和日期的Javadoc。

例如

/**
 * @author eric
 * @date Apr 3, 2015 8:49:31 PM
 */

在IDEA中,我尝试过,但是它只是生成一个没有作者或日期的空Javadoc。

例如

/**
 * 
 */

问题是:

  • 在IDEA中,如何使用作者和日期部分生成与Eclipse相同的javadoc?
  • 是否可以在创建类型时自动生成它?
  • 默认的快捷方式是什么?

@更新-摘要

根据评论和答案,将以下javadoc添加到文件模板:

/**
 * @author ${USER}
 * @date ${DATE} ${TIME}
 */

对于文件类型:ClassInterfaceEnumAnnotationType

Javadoc将在创建类型时自动添加。
但是似乎仍然没有捷径可以手动添加现有类型。

2 个答案:

答案 0 :(得分:2)

对于类,接口等,您可以编辑文件模板:Preferences | Editor | File and Code Templates

/**
 * @author Eric
 * @date ${DATE}
 */

对于可以生成的方法(如getter,setter),您可以使用以下答案:https://stackoverflow.com/a/38094408/3124227

对于方法,没有编辑Javadoc的功能:https://youtrack.jetbrains.com/issue/IDEA-97658

答案 1 :(得分:-2)

为什么要?这正是版本控制系统可以帮助您跟踪的信息!例如,您可以通过运行std::function从Git获得此功能。

(感谢https://stackoverflow.com/a/13598028的特定代码段。)

需要明确的是,我并不反对Javadoc整体,只是使用它来手动跟踪在其他地方自动跟踪的信息。