PHP 变量或者语句注释
2023-04-04 14:08 更新
程序中变量或者语句的注释遵循以下原则:
a. 写在变量或者语句的前面一行,而不写在同行或者后面;
b. 注释采用/* */的方式;
c. 每个函数前面要包含一个注释块。内容包括函数功能简述,输入/输出参数,预期的返回值,出错代码定义。
d. 注释完整规范。
e. 把已经注释掉的代码删除,或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。
例子:
/** * @Purpose: * 数据库连接用户名 * @Attribute/Variable Name: db_user_name * @Type: string */ var db_user_name;
以上内容是否对您有帮助:
更多建议: