java - 使 JavaDoc 对重构具有鲁棒性

标签 java refactoring javadoc

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

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

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

最佳答案

当使用 eclipse 进行重构时,您还可以在 xml 文件等内容中搜索字符串引用。

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

关于java - 使 JavaDoc 对重构具有鲁棒性,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/7391139/

相关文章:

Java Spring IOC 构造函数参数注入(inject)一个 List<Integer>

refactoring - 什么时候调用四人组? [什么时候使用设计模式?]

嵌入语法高亮源代码的 javadoc doclet

java - 如何在Hibernate中添加有关Annotations的JavaDoc信息?

添加对象时 Java ArrayList 大小变得巨大

java.lang.NoSuchMethodError : org. jboss.logging.Logger.debugf(Ljava/lang/String;I)V WebLogic部署

java - 如何立即返回 String Builder 对象作为 rdd ?或者将 String Builder 对象转换为 rdd?

javascript - 将 url 文件夹与标签 href 匹配以使其处于事件状态

c# - 我想重构我的加载游戏脚本

java - "/* (non-javadoc)"有很好理解的含义吗?