当我修改别人的代码时，如何修改Javadoc？

Question

我正在处理别人的代码并进行重大修改。（我正在将其转换为使用与他最初使用的数据库不同的数据库。）我如何在Javadoc注释中表明我不是该代码的原始作者，但我确实为其做出了贡献。有没有干净或标准的方法来做到这一点？我的谷歌搜索并没有帮我弄清楚这一点。

示例：

/**
* This class does some really awesome stuff.
* 
* @author Steph the Great - Modified to use PostgreSQL instead of Derby;
*         added comments to the code
*/

我也不知道原作者的名字，所以我只能放下我自己。

Answer 1

这些注释不属于javadoc：-）javadoc应该解释合同——它是自动生成的"文档"中提取和显示的内容。剩下的只是普通的注释，或者，在本例中可能更好的是，SCM日志条目，在javadoc中没有位置！

我可能会离开原作者，但如果你想获得荣誉。。。

请参阅@authorjavadoc参考资料，并注意它可以被多次包含。本节明确涉及多个作者和排序等。

/**
* This class does some really awesome stuff.
* It uses PostreSQL. 
*
* @author Steph the Great
* @author Freddy Four Fingers
*/
// DEC2012 - Fred - Modified to use PostgreSQL instead of Derby (but really, use SCM!)
class Awesome { ... }

快乐的编码。

---

关于和文章中的例子有些无关的问题的说明。。。如果作者不为人所知，那么可以做几件事。首先，添加一个链接或引用，指向原始来源的获取位置——为了清晰起见，还可以注意到可选的"我最初没有写这个"。

然后，根据您的喜好：

1. 不要指定@author字段，甚至不要指定您自己这不是必需的
2. 将您自己添加为唯一作者；上面在javadoc中提到了原始源代码
3. 添加一个伪作者和您自己作为第二作者，例如
@author Unknown@author unascribed（请参阅注释和@author）
4. 在许可证的条款范围内做任何你想做的事（如果有的话）

Answer 2

您可以有多个@author标记。所以，如果你对一个类做了大量的更改，只需添加一个新的@author标签，里面有你自己的名字。没有必要列出你所做的更改——修订历史应该足够好地显示这一点。