使用phpDocumentor的@since标记记录函数

Question

我的项目中有一个函数my_function()，我想在下一个版本中重命名。我的项目目前是1.0版，所以我的下一个版本将是1.1。

/**
 * Summary
 *
 * @since 1.0
 */
function my_function() {
    // Stuff.
}

正如您在上面的示例中所看到的，我正在使用phpDocumentor docblocks记录我的代码。如果我继续更改此函数的名称，我应该将@since标记增加到1.1吗？我试图了解函数名称更改是否意味着函数被视为新元素。提前谢谢。

Answer 1

如果您的功能名称将被更改，这将是另一个功能。 您的api或其他用户应该重写他们的代码，因为之前的功能将不再受支持。因此，对于新函数，您应该更改@since属性。