【问题标题】:How do I change the Javadocs template generated in Eclipse?如何更改 Eclipse 中生成的 Javadocs 模板?
【发布时间】:2011-02-06 10:40:36
【问题描述】:

我不喜欢创建类或方法时为我生成的默认 Javadocs,尤其是 @author 变量,它是我的 windows 框上的当前系统用户名。

我想改变它。这可能吗?

【问题讨论】:

  • 对于@author变量自定义,您可以通过编辑eclipse.ini文件添加-Duser.name=customstring来设置您的自定义字符串(在Kepler / Luna中测试
  • 你最好去掉@author标签,因为它是一个unwanted noise

标签: java eclipse templates javadoc


【解决方案1】:

查看Preferences / Java / Code Style / Code Template

部分Comment / Type

您可以将author 标记替换为您需要的任何值,它将对新生成的类产生影响。


但是,如果模板没问题,但是引用购买作者标签的值不是,请看这个SO question

${user} 使用user.name 环境变量的值;因此,您可以在eclipse.ini 中传递-Duser.name=My Name 来覆盖它。

或者,如果您愿意,可以修改快捷方式以指向:

C:/java/eclipse/eclipse.exe -vmargs -Duser.name="cleverUserNameToUseInSourceCode"

  • MacOs: Aram Kocharyan mentions eclipse.iniEclipse.app/Contents/MacOS/ 中,如果您右键单击并选择显示包内容。
  • ZendStudio:roffloxcomments 文件名为ZendStudio.ini,位于Applications/Zend Studio.app/Contents/MacOS/

【讨论】:

  • 无关:你是如何生成这么漂亮的截图的?
  • @Paul:在那个 meme 显示为“强制性”(meta.stackexchange.com/questions/19478/the-many-memes-of-meta/…)之后,我不得不使用 FSCapture(faststone.org/FSCaptureDetail.htm)来遵守;)
  • 截图工具可以在 Win7 上解决问题。感谢您的屏幕截图。这正是我今晚所需要的! :)
  • 对于 Mac 用户,eclipse.ini 位于 Eclipse.app/Contents/MacOS/ 如果您右键单击并显示包内容
  • Zend Studio for Mac 也是如此。 ZendStudio.ini 位于 Applications/Zend Studio.app/Contents/MacOS/
【解决方案2】:

查看窗口 -> 首选项 -> Java -> 编辑器 -> 模板。

【讨论】:

  • 是的,我知道这一点,但不幸的是,这似乎对类的代码生成没有任何影响。我想避免手动执行此操作
【解决方案3】:

Spring Tool Suite(用于 Spring 开发的流行 Eclipse 定制)使用 STS.ini。在 Windows 上,我发现它与应用启动可执行文件位于同一目录中。

【讨论】:

  • 对于 Mac OS 上的 STS,请在搜索 STS 应用程序包时查看 VonC 的答案。
【解决方案4】:

要使用 Git 用户名和电子邮件,您可以使用变量 ${name:git_config(user.name)}${email:git_config(user.email)}.

【讨论】:

  • 这位于Preferences / Java / Code Style / Code Templates / Comments / Types
【解决方案5】:

您应该考虑使用JAutodoc,这是一个非常有用的Eclipse 插件。参数化比标准的 Eclipse 生成要先进得多。

【讨论】:

  • 有没有办法用JAutoDoc代替eclipse的eclipse javadoc生成?我的意思是:我已经安装了 JAutoDoc 插件。如果我现在通过 Shft+Alt+S 生成 get/setter 方法并选择“Generate Getters and Setters...”,javadoc cmets 仍然由 eclipse 生成。但是我想通过 JAutoDoc 自动生成这个 cmets...
猜你喜欢
  • 2013-05-17
  • 1970-01-01
  • 2011-11-15
  • 2020-04-08
  • 2014-10-26
  • 1970-01-01
  • 2012-06-16
  • 2016-03-15
  • 1970-01-01
相关资源
最近更新 更多