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
。