2

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

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

只是将来我知道，为什么要更改/创建某个功能或行？

4

1 回答 1

3

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

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

于 2012-09-25T08:32:55.563 回答