使用 phpDocumentor 的 @since 标签记录函数
Documenting a function with phpDocumentor's @since tag
我的项目中有一个函数 my_function()，我想在下一个版本中重命名它。我的项目目前是 1.0 版，所以我的下一个版本将是 1.1。
/**
* Summary
*
* @since 1.0
*/
function my_function() {
// Stuff.
}
如您在上面的示例中所见，我正在使用 phpDocumentor 文档块记录我的代码。如果我继续更改此函数的名称，是否应该将 @since 标记增加到 1.1？我试图了解函数名称更改是否意味着该函数被视为新元素。提前致谢。
如果您的函数名称将更改，这将是另一个函数。
你的 api 或其他用户应该重写他们的代码，因为以前的功能将不再受支持。因此，对于一个新函数，您应该更改 @since 属性。
我的项目中有一个函数 my_function()，我想在下一个版本中重命名它。我的项目目前是 1.0 版，所以我的下一个版本将是 1.1。
/**
* Summary
*
* @since 1.0
*/
function my_function() {
// Stuff.
}
如您在上面的示例中所见，我正在使用 phpDocumentor 文档块记录我的代码。如果我继续更改此函数的名称，是否应该将 @since 标记增加到 1.1？我试图了解函数名称更改是否意味着该函数被视为新元素。提前致谢。
如果您的函数名称将更改，这将是另一个函数。 你的 api 或其他用户应该重写他们的代码，因为以前的功能将不再受支持。因此，对于一个新函数，您应该更改 @since 属性。