【发布时间】：2011-10-24 20:06:02
【问题描述】：
对于我们的内部开发，通常使用将 java 类的作者写入类注释。
会写成
* @author Doe, John (john.doe@example.com)
所有作者都将在此表格中列出，在该课程中完成最多工作的作者将排在第一位。
我的问题：您如何处理这样的要求？您是在评论中设置作者身份还是使用源存储库来跟踪此信息？写作者姓名和电子邮件的最佳格式是什么？
【问题讨论】：
【发布时间】：2011-10-24 20:06:02
【问题描述】：
您的源代码管理拥有关于谁在课堂上做了什么以及什么时候做的最正确的信息。它是唯一可靠的信息来源（除非多个用户共享相同的用户名/密码）。
我通常不关心@author 标签，大部分时间它是由IDE 在创建类时自动插入的。随心所欲地使用它，并选择所需的格式。
顺便说一句，谁的工作量更大？是编写整个课程代码的人，还是经过两周调查后更改一行代码以修复生产错误的人？
【讨论】：
-
您的问题
who does the more work很有趣，但很周到。 -
我知道我（阅读：我个人和我的大多数开发人员伙伴）从源代码控制系统获得了关于作者身份的最可靠信息。但也有其他一些团队成员（如项目经理、部署主管……）有不同的看法。例如，他们查看我们的票务跟踪器。对于这些人来说，快速查看与谁联系很有用。
我喜欢这种格式：
* @author <ul><li>John Doe (john.doe@example.com)</li><li>...</li>...</ul>
它会打印一份关于姓名和电子邮件的列表。我喜欢以这种格式查看名称和电子邮件。它很容易阅读。 Surname, name 的格式我觉得太正式了。它不是按姓氏订购的，所以为什么要麻烦？
【讨论】：