使用phpDocumentor记录代码更新和日期的不同作者的方法
P粉080643975
P粉080643975 2024-01-10 18:12:54
[PHP讨论组]

假设一个类的原始文档如下:

/**
 * 我的自定义类
 *
 * 这个类帮助你做一些事情。它真的很棒。
 *
 * 作者:David Smith
 * 版本:1.0
 */
  1. 如果我对50%的代码进行了重写,如何记录我做出的重要贡献?

  2. 添加日期的最佳方式是什么?例如,代码最后一次修改的日期,我进行更新的日期,或版本更新的日期。

P粉080643975
P粉080643975

全部回复(2)
P粉545218185

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

/**
 * 我的自定义类
 *
 * 这个类可以帮助你做一些事情。非常好用。
 *
 * 作者:David Smith
 * 版本:1.0
 *
 * 修改者:Rahul Parkar
 * 修改日期:09/11/2012
 */

此外,我还看到他们使用了两种方法来记录变更,一种是使用类似Git的方式,每个提交都有一个提交信息,另一种是使用另一个文档标签来记录变更。

P粉512526720

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

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

热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习
PHP中文网抖音号
发现有趣的

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号