假设一个类的原始文档如下所示:
/**
* My custom class
*
* This class helps you do stuff. It's really great.
*
* @author David Smith
* @version 1.0
*/
如果我来修改 50% 的代码,我如何证明我做出了重大贡献?
添加日期的最佳方法是什么?例如,上次修改代码的时间、我进行更新的时间或版本的更新时间。
假设一个类的原始文档如下所示:
/**
* My custom class
*
* This class helps you do stuff. It's really great.
*
* @author David Smith
* @version 1.0
*/
如果我来修改 50% 的代码,我如何证明我做出了重大贡献?
添加日期的最佳方法是什么?例如,上次修改代码的时间、我进行更新的时间或版本的更新时间。
我在这些年来工作过的公司中看到的一种方法就是这样做
/**
* My custom class
*
* This class helps you do stuff. It's really great.
*
* @author David Smith
* @version 1.0
*
* @modifier Rahul Parkar
* @modifiedDate 09/11/2012
*/
另外,我看到他们使用 2 种方法来记录更改,一种是使用 Git 之类的东西,其中每个提交都有一个提交消息,另一种是使用另一个 Doc 标签来记录更改。
我知道我并没有真正回答你的问题,但我想知道你为什么要使用@author。
要跟踪代码更改(谁创建了文件?谁更改了它?),请使用您的版本控制系统。毕竟,这就是它的用途:)