【问题标题】:Making JavaDoc robust against refactoring使 JavaDoc 对重构具有健壮性
【发布时间】:2011-09-12 16:39:52
【问题描述】:

我正在开发一个不断重构以改进它的应用程序。现在,如果我们重命名某个类以更好地捕捉其意图,那么所有提及该类的文档都不会自动更新,除非您使用链接 ({@link ClassName}) 来引用该类。

然而,JavaDoc 原则声明应该“经济地使用内联链接”,因为链接会脱颖而出并引起读者的注意,我认为这是明智的。您也不能链接到方法的参数。

JavaDoc 中是否有另一种方法可以使 cmets 对重构更加健壮,我不知道?

【问题讨论】:

  • 你是如何重构的?在 Eclipse 中重命名时,可以选择通过 cmets 进行搜索。
  • 是的,我使用 Eclipse,我记得我见过。但是,我没有获得该选项(使用 Ctrl+Alt+R),并且我在设置中找不到任何内容来更改它。无论如何,这在大多数情况下都行得通,但它当然可能是模棱两可的。
  • IntelliJ 搜索 cmets、字符串和文件以查找要重命名的内容。它还提供重命名字段、变量和参数。我假设 Eclipse 也是如此。

标签: java refactoring javadoc


【解决方案1】:

当使用 eclipse 进行重构时,您也可以搜索 xml 文件中的字符串引用。

按 Shift-Alt-R 两次 以获取对话框。 (在 Mac 上是 Option-Command-R 两次

【讨论】:

  • 谢谢!这不是我真正想要的,但我想这对我来说是最好的解决方案。
  • 我想,现在是 Alt+Shift+R。
  • 两者都不会在 {@link} 中搜索
  • @this - 修复了我有一台 Mac,所以我在猜测 :-)
  • @Gangnus - 链接已为我修复。我总是浏览重命名的预览,我看到链接引用发生了变化。
猜你喜欢
  • 1970-01-01
  • 2012-01-12
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2010-10-10
  • 2014-05-02
  • 2020-02-08
相关资源
最近更新 更多