php - 在 PHP 代码中使用 @since

标签 php phpdoc comments

我在我的 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 的函数。如果您在 v3 中将 foo 更改为 bar 但将 @since 保留为 v1,那么您的文档会错误地声明调用 是安全的v1中的bar()。事实上,v1中没有bar(),调用会报错。

您还可以考虑保留一个具有旧名称的函数 stub (它只调用真正的函数),并将其标记为 @deprecated .

关于php - 在 PHP 代码中使用 @since,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/14929179/

相关文章:

php - 属性中的简单 HTML DOM 通配符

php - 如何使用 PHP shell_exec 添加新用户到 Kamailio?

php - AWS Lambda错误: Error: Runtime failed to start: fork/exec/opt/bootstrap: no such file or directory

php - PHPDocumentor 中的类型转换

comments - Geany 文本编辑器评论

javascript - 删除前如何在 toastr 中要求确认

php - phpDoc中是否需要定义参数类型?

php - 如何在 PHP 中记录静态类属性

swift - 将自定义文档添加到重写函数

ruby-on-rails - 在 erb 中添加评论的最佳方式