在PHP代码中使用@since

发布时间：2020-12-13 14:05:27 所属栏目：PHP教程来源：网络整理

导读：我在 PHP代码中使用@since注释.我有一个关于它的使用的问题.说我有一个执行特定任务的功能,它已经在版本1.0中实现了. 所以我目前有@since 1.0. 现在我继续改变函数的名字,虽然内部的代码保持不变. 现在应该说@since 3.0(当前版本)还是保持@since 1.0？函数

我在 PHP代码中使用@since注释.我有一个关于它的使用的问题.说我有一个执行特定任务的功能,它已经在版本1.0中实现了.

所以我目前有@since 1.0.

现在我继续改变函数的名字,虽然内部的代码保持不变.
现在应该说@since 3.0(当前版本)还是保持@since 1.0？

函数名不存在于1.0,所以@since应该是3.0.不同名称的功能在旧版本中提供相同的功能是无关紧要的您将无法在旧版本中使用新的名称. docs说：

Use @since to document revisions,as in “This function has been a part of this package since version 2.0”

@since的目的是告诉某人使用你的包,“从版本x,一个名为foo的函数存在,如果你将foo变成v3中的bar,但将@since设为v1,那么你的文档会错误地声明它是安全的在v1中调用bar()实际上,v1中没有bar(),并且调用会引发错误.

您也可以考虑使用旧名称保留功能存根(仅调用实际功能),并将其标记为@deprecated.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!