我在
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(),并且调用会引发错误.
原文地址:https://www.jb51.cc/php/131001.html
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。