简体中文
简体中文
为 PHP 函数编写清晰且全面的文档对于模块化、可维护和团队协作的代码至关重要。遵循标准化的文档惯例有助于确保文档一致且易于理解。
函数名称应以小写字母开头，并使用下划线分隔单词（例如：my_function）。同时，遵循 PSR-2 命名约定，类和方法名称应使用驼峰命名法（例如：MyFunction）。
使用 @param 标签指定函数参数的类型和描述。
/**
* @param string $name 用户名
* @param string $password 密码
*/
function login(string $name, string $password) {}
使用 @return 标签指定函数的返回值类型和描述。
/**
* @return bool 登录是否成功
*/
function login(string $name, string $password): bool {}
使用 @throws 标签指定函数可能引发的异常类型和描述。
/**
* @throws InvalidArgumentException 如果 $name 或 $password 为空
*/
function login(string $name, string $password): bool {}
符合 PSR-5 注释块标准的函数注释示例：
/**
* 登陆用户
* @param string $name 用户名
* @param string $password 密码
* @return bool 登录是否成功
* @throws InvalidArgumentException 如果 $name 或 $password 为空
*/
function login(string $name, string $password): bool {}
示例：获取当前时间。
/**
* 获取当前时间
* @return string 当前时间字符串
*/
function get_current_time(): string {
return date('Y-m-d H:i:s');
}
示例：计算两个数字的和。
/**
* 计算两个数字的和
* @param int $a 第一个数字
* @param int $b 第二个数字
* @return int 和
*/
function sum(int $a, int $b): int {
return $a + $b;
}
