我在
PHP代码中使用@since注释.我有一个关于它的使用的问题.说我有一个执行特定任务的功能,它已经在版本1.0中实现了.
@H_301_7@所以我目前有@since 1.0.
现在我继续改变函数的名字,虽然内部的代码保持不变.
现在应该说@since 3.0(当前版本)还是保持@since 1.0?
所以我目前有@since 1.0.
现在我继续改变函数的名字,虽然内部的代码保持不变.
现在应该说@since 3.0(当前版本)还是保持@since 1.0?
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(),并且调用会引发错误.