描述性命名约定有助于使您的代码更具可读性、可维护性和自记录性。通过使用清楚传达变量、函数和类用途的名称,您可以帮助自己和其他人理解您的代码,而无需额外的注释或解释。
以下是如何在 php 中采用描述性命名约定以及实用指南和示例:
1. 使用名词作为类名
- 类名应该代表它们管理的实体。描述性的类名称阐明了该类在系统中的角色。
- 使用 pascalcase 命名类名。
- 使用反映类的对象或职责的名称。
示例:
useraccountmanager:负责管理用户帐户的类。
invoicegenerator:处理发票生成的类。
shoppingcart:代表购物车系统的类。
2. 使用动词作为函数和方法名称
- 方法执行操作,因此它们应该用描述它们所做的事情的动词或动词短语来命名。
- 方法和函数名称使用驼峰命名法。
- 为清楚起见,使用 get、set、create、update、delete、is、has 等动词作为前缀。
示例:
createuser():明确指出该函数创建一个用户。
calculatetotalamount():描述计算总金额的动作。
isuserloggedin():检查用户是否登录的方法。
3.变量名称要具体
- 变量应表明它们存储或代表什么。
- 避免使用简短或不明确的名称,例如 $x、$val、$data。
- 变量名使用驼峰命名法。
- 考虑变量的范围和意图。
示例:
$totalorderamount:存储订单的总金额。
$useremailaddress:清楚地显示它保存着用户的电子邮件地址。
$invoiceitems:代表发票中的项目,而不仅仅是通用的 $items。
4.避免过于通用的名称
- 避免使用 $data、$info、$result 等名称,除非它们在该上下文中特别有意义。
- 在适当的情况下提供特定上下文,例如 $userdata、$productinfo 或 $searchresult。
5.布尔变量应该问一个问题
- 如果变量是布尔值,则其名称应反映真/假问题。
- 使用 is、has、should、can 作为前缀来表明它是一个布尔值。
示例:
$isactive:明确表明它是一个布尔值,用于检查某些内容是否处于活动状态。
$hasaccess:检查用户是否有权访问资源。
$canedit:指示当前用户是否可以编辑项目。
6. 常量应该具有描述性和具体性
- 常量应反映不可变值并以大写蛇形命名。
- 避免像 default_value 这样的通用名称,而更喜欢更具描述性的名称。
示例:
max_login_attempts:清楚地描述了允许的最大登录尝试次数。
default_currency_code:描述交易中使用的货币代码。
error_code_invalid_email:与电子邮件验证失败相关的描述性错误代码。
7. 集合命名
- 如果变量表示集合(例如,项目数组),请通过使用复数名词或添加单词列表来使其清晰。
示例:
$userlist:用户的集合。
$products:产品对象的集合。
$orderitems:订单中的项目数组。
实际例子
1 2 3 4 5 6 7 8 9 10 |
|