0

0

PHP 中描述性命名约定的实践:编写简洁可读代码的指南

PHPz

PHPz

发布时间:2024-09-06 08:18:00

|

1026人浏览过

|

来源于dev.to

转载

php 中描述性命名约定的实践:编写简洁可读代码的指南

描述性命名约定有助于使您的代码更具可读性、可维护性和自记录性。通过使用清楚传达变量、函数和类用途的名称,您可以帮助自己和其他人理解您的代码,而无需额外的注释或解释。

以下是如何在 php 中采用描述性命名约定以及实用指南和示例:

通义听悟
通义听悟

阿里云通义听悟是聚焦音视频内容的工作学习AI助手,依托大模型,帮助用户记录、整理和分析音视频内容,体验用大模型做音视频笔记、整理会议记录。

下载

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:订单中的项目数组。

实际例子

class ShoppingCart {
    private $cartItems = [];
    private $totalCartValue = 0;

    public function addItemToCart($productId, $quantity) {
        $itemPrice = $this->getProductPriceById($productId);
        $this->cartItems[] = [
            'productId' => $productId,
            'quantity' => $quantity,
            'price' => $itemPrice

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2740

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1671

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1530

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

995

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1464

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1235

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1549

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1307

2023.11.13

AO3中文版入口地址大全
AO3中文版入口地址大全

本专题整合了AO3中文版入口地址大全,阅读专题下面的的文章了解更多详细内容。

1

2026.01.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
SQL 教程
SQL 教程

共61课时 | 3.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号