【发布时间】：2012-09-16 17:12:28
【问题描述】：
我遇到了一个问题，想更改我的 java 代码中的功能，例如 #41241 问题编号。
指定问题编号的正确 Javadoc 注释是什么，要求进行此更改？
只是将来我知道，为什么某个函数或行被更改/创建？
【问题讨论】：
-
恕我直言，这取决于票务/错误跟踪系统。我通常会像
/** changed xyz for issue #123 */或/** as described in issue AB01-345, this needs to be changed to ... */这样的 cmets 在 Mylyn 的帮助下，这非常好，因为您可以直接跳转到跟踪系统中的相应问题。 -
谨防将错误编号放入源代码 cmets。这就是源代码控制系统的用途。在您添加此类评论后的 6 个月左右，它变得完全无用并且使代码变得模糊。
标签： java comments javadoc issue-tracking