php 函数文档编写规范要求版本描述遵循 v.. 格式,其中主版本号代表重大更改,次版本号代表次要更改,发行版本号代表维护更新。
PHP 函数文档编写规范 - 函数版本描述
在 PHP 函数文档编写规范中,对函数版本的描述有以下要求:
格式:
版本 v..
主版本号:
代表函数重大的不兼容更改。
次版本号:
代表函数的次要更改,例如新功能的添加。
发行版本号:
代表函数的维护更新,例如错误修复。
示例:
版本 v7.4.12
实战案例:
以下是一个示例函数文档,其中包含了版本描述:
/** * 计算两个数的和 * * @param int $num1 第一个数 * @param int $num2 第二个数 * @return int 两个数的和 * * @version v8.1.0 */ function sum(int $num1, int $num2): int { return $num1 + $num2; }
在上面的示例中,sum
函数当前处于版本 v8.1.0
。
以上就是PHP 函数文档编写规范中对函数版本的描述要求是什么?的详细内容,更多请关注每日运维网(www.mryunwei.com)其它相关文章!