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中没有位置！

我可能会离开原作者，但如果你想要信用......

...请参阅@author javadoc参考，并注意它可以多次包含。本节explicitly relates to multiple authors和订购等

/**
* 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 { ... }

快乐的编码。

关于问题的注释与帖子中的例子有些无关......如果作者不知道，那么可以做几件事。首先，添加一个链接或引用，以获取原始源的位置 - 为了清晰起见，可选择“我最初没有写这个”。

然后，根据您的偏好：

不要指定 @author字段 - 甚至不是您自己。 这不是必需的。
将自己添加为唯一作者;上面在javadoc
添加假作者和您自己作为第二作者，例如 ~~@author Unknown~~ @author unascribed（请参阅评论及@author）。
根据许可条款做任何你想做的事情，如果有的话。

Answer 2

您可以拥有多个@author代码。因此，如果您对某个类进行了大量更改，只需在其中添加一个包含您自己名称的新@author标记。没有必要列出你所做的改变 - 修订历史应该足够好。

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

2 个答案: