我遇到了一个问题,想要更改我的 java 代码中的功能,问题编号例如 #41241。
指定请求此更改的问题编号的正确 Javadoc 注释是什么?
只是将来我知道,为什么某个函数或行被更改/创建?
最佳答案
我不会将问题编号写入源代码中。当一个方法由于多个问题而改变时,这可能会变得复杂......
我曾经将问题号添加到 SVN 提交中,例如:ISSUE-1234:添加了 NPE 检查。 Eclipse 提供了有用的功能Team -> Show Annotations
,它显示 SVN 提交的每一行的更改以及提交注释。在我看来,这作为 JavaDoc 中的注释增加了更多好处。
关于指定问题编号的 Javadoc,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/12578655/