指定问题编号的 Javadoc

标签 java comments javadoc issue-tracking

我遇到了一个问题,想要更改我的 java 代码中的功能,问题编号例如 #41241。

指定请求此更改的问题编号的正确 Javadoc 注释是什么?

只是将来我知道,为什么某个函数或行被更改/创建?

最佳答案

我不会将问题编号写入源代码中。当一个方法由于多个问题而改变时,这可能会变得复杂......

我曾经将问题号添加到 SVN 提交中,例如:ISSUE-1234:添加了 NPE 检查。 Eclipse 提供了有用的功能Team -> Show Annotations,它显示 SVN 提交的每一行的更改以及提交注释。在我看来,这作为 JavaDoc 中的注释增加了更多好处。

关于指定问题编号的 Javadoc,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/12578655/

相关文章:

java - 部署在 Tomcat 上的 WAR 文件不读取 application.properties 文件

vim 确实删除了以 # 字符开头的所有行的缩进

java - 创建一个单独的 jar,其中包含已编译的类和 javadoc,无需 Maven

java - javadoc 如何知道每个文档注释针对哪个方法?

java - 在 Travis CI 上访问 mvnsearch.org 时如何避免 "The job exceeded the maximum time limit for jobs, and has been terminated."?

java - PrintWriter 到 JTextArea,在调用的方法关闭之前不会显示任何内容

html - 如何在 HTML 代码中注释/取消注释

java - 我怎样才能得到所有方法的 javadoc 与特定的注释,方法名称和包/类名称?

java - 已建立连接但没有互联网的 UnknownHostException 超时

java - 评论源代码以了解整个项目的工作流程的最佳方法?