@since的PHPDoc用法

时间:2012-08-27 16:09:40

标签: phpdoc

@since用于显示创建函数的版本。如果我稍后修改该函数,如果我更改@since值或执行其他操作以显示存在更改,该怎么办?

1 个答案:

答案 0 :(得分:0)

“@since”的基本用例确实只是表示首次引入方法时的包版本。

但是,由于这个标签的内容实际上只是自由格式的文本,而且我不知道任何文档软件用于特殊创建任何其他文档元素(例如,方法组的报告按什么版本介绍它们) ,然后我真的不担心以其他方式使用标签。

例如,将原始的“@since 2.0 foo()介绍”更改为“@since 2.7 foo($ arg)”以显示API已更改。我甚至可以使用多个标签来显示方法API的历史记录:

* @since 2.0 foo() introduced
* @since 2.7 foo($arg) added the $arg argument to the signature
* @since 2.9 foo($arg = 'default') set a default for $arg