Documentation phpDocumentor-如何记录不同作者的更新代码和日期?

Documentation phpDocumentor-如何记录不同作者的更新代码和日期?,documentation,phpdoc,code-documentation,Documentation,Phpdoc,Code Documentation,假设类的原始文档如下所示: /** * My custom class * * This class helps you do stuff. It's really great. * * @author David Smith * @version 1.0 */ 如果我参与并返工了50%的代码,我如何记录我做出的重大贡献 添加日期的最佳方式是什么?e、 g.上次修改代码的时间、我进行更新的时间或版本更新的时间 我在我工作多年的公司看到的一种方法就是这样做 /** * My

假设类的原始文档如下所示:

/**
 * My custom class
 *
 * This class helps you do stuff.  It's really great.
 *
 * @author  David Smith
 * @version 1.0
 */
  • 如果我参与并返工了50%的代码,我如何记录我做出的重大贡献

  • 添加日期的最佳方式是什么?e、 g.上次修改代码的时间、我进行更新的时间或版本更新的时间


  • 我在我工作多年的公司看到的一种方法就是这样做

     /**
     * 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
     */
    

    此外,我还看到他们使用两种方法来记录更改,一种是使用Git之类的东西,其中每个提交都有一条提交消息,另一种是使用另一个文档标记来记录更改。

    我在多年工作的公司中看到的一种方法就是这样做

     /**
     * 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
     */
    

    另外,我看到他们使用两种方法来记录更改,一种是使用Git之类的东西,其中每个提交都有一条提交消息,另一种是使用另一个Doc标记来记录更改。

    我知道我并没有真正回答您的问题,但我想知道您为什么要使用@author


    要跟踪代码更改(谁创建了文件?谁更改了文件?),请使用版本控制系统。毕竟,这就是它的目的:)

    我知道我并没有真正回答你的问题,但我想知道你为什么要使用@author


    要跟踪代码更改(谁创建了文件?谁更改了文件?),请使用版本控制系统。毕竟,这就是它的目的:)

    我同意,但有些恶劣的地方不使用(真正的)源代码管理。。。我不得不在那样的地方工作。。。这是错误的。@Fusselwurm有效点,但如果类在版本控制之外分发,该怎么办?+1。我的团队使用author字段来表示一个非常了解该方法的人——与其说是最初编写代码的人,不如说是保管人。因此,如果你点击代码并想问一些关于它的问题,它们是“一个很好的起点”。关于谁更改了什么、何时更改了什么、为什么更改了什么的更多细节,签入历史是完美的——为什么要用这些信息污染代码。我同意@BadHorsie的观点,代码倾向于在版本控制之外分发,例如,如果你为外部客户工作,如果你在做开源(有人把它放在不同的产品中)诸如此类。版本控制只适用于开发人员/维护过程的团队。然而,代码可能存在于它之外。我同意,但一些恶劣的地方不使用(真实的)源代码管理…我必须在这样的地方工作…这是错误的。@Fuselwurm有效点,但是如果类在版本控制之外分发呢?+1。我的团队使用author字段来表示一个非常了解该方法的人-与其说是最初编写代码的人,不如说是保管人。所以如果你点击代码并想问一些关于它的问题,他们是“一个很好的起点”。要了解更多关于谁更改了什么、何时更改了什么、为什么更改了什么的详细信息,签入历史是完美的-为什么要用这些信息污染代码。我同意@BadHorsie的观点,代码倾向于在版本控制之外分发,例如,如果您为外部客户工作,如果您正在进行开源(有人把它放在不同的产品中)等等。版本控制只针对开发人员/维护过程的团队。但是,代码可能存在于它之外。