如何在java类注释中设置作者？

Question

对于我们的内部开发，将java类的作者写入类注释是很常见的。

将以

的形式编写

* @author Doe, John (john.doe@example.com)

所有作者都将以此形式列出，在本课程中做得最多的人将首先列出。

我的问题：你如何处理这样的要求？您是在评论中设置作者身份还是使用源存储库来跟踪此信息？写作者姓名和电子邮件的最佳格式是什么？

Answer 1

您的源代码管理拥有关于谁在课堂上做什么以及何时做的最正确的信息。它是唯一可靠的信息来源（除非多个用户共享相同的用户/密码）。

我通常不关心@author标记，大多数时候IDE会在创建类时自动插入。根据需要使用它，并选择所需的格式。

顺便说一下，谁做的工作更多？编写整个类代码的人，或者在调查两周后更改一行代码来修复生产错误的人？

Answer 2

我喜欢这种格式：

* @author <ul><li>John Doe (john.doe@example.com)</li><li>...</li>...</ul>

它打印一个关于姓名和电子邮件的列表。我喜欢看那种格式的名字和电子邮件。它很容易阅读。格式Surname, name我发现它太正式了。它不打算由Surname订购，为什么要这么麻烦？