Warning: file_get_contents(/data/phpspider/zhask/data//catemap/1/php/258.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181

Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/sharepoint/4.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Php 选择有效的函数名_Php_Coding Style_Naming_Code Cleanup - Fatal编程技术网

Php 选择有效的函数名

Php 选择有效的函数名,php,coding-style,naming,code-cleanup,Php,Coding Style,Naming,Code Cleanup,我正在寻找关于编写一个好的函数名作为我正在开发的网页的一部分的建议。它是用PHP编码的,该函数基本上将保存客户出勤信息的数组数据重新组装到音乐场所(例如时间、日期、入口等)。该函数接收数组数据并返回格式化为字符串的信息,该字符串包含HTML结构 例如: //function formats array ... $returnStr = "<span class='bold'>Entrance</span>customerData['entrance']"; //函数格式

我正在寻找关于编写一个好的函数名作为我正在开发的网页的一部分的建议。它是用PHP编码的,该函数基本上将保存客户出勤信息的数组数据重新组装到音乐场所(例如时间、日期、入口等)。该函数接收数组数据并返回格式化为字符串的信息,该字符串包含HTML结构

例如:

//function formats array
...
$returnStr = "<span class='bold'>Entrance</span>customerData['entrance']";
//函数格式数组
...
$returnStr=“入口客户数据['entrance']”;
我问这个问题的原因是,我提出的任何函数名要么过于冗长,要么不完全清楚它的含义。我必须维护大量的代码,所以我试图选择有效的名称,这样当我重新访问代码时,我可以快速掌握正在发生的事情


任何在线资源或个人见解都将不胜感激。

在这种情况下,没有黑白之分。但我认为最佳做法应该是:

  • 逻辑-描述函数的功能
  • 舒适-短而中肯
因此,您不必考虑“等等,执行X和Y的函数的名称是什么?”也不必编写太多代码,例如:
printmusicvenuefromrarray

“合乎逻辑”和“舒适”两个方面都是主观的,不同的人可能会有所不同,所以只要只有你在做那个项目——做感觉正确的事情

当您有一个开发团队在一个项目上工作时,请考虑之前绘制一些指南。

首先用文字描述函数,输入是什么,输出是什么。 考虑代码中已经存在的类似名称的其他函数(不想混淆)。 根据你的描述:

该函数基本上重新组装保存客户出席的阵列数据 音乐场所的信息(例如时间、日期、入口等)。这个 函数接收数组数据并返回格式为 包含HTML结构的字符串

输入 将客户出席信息保存到音乐场所的阵列数据

输出 (return)格式化为包含HTML结构的字符串的信息

通常,当我编写返回某些内容的函数时,我会从
get
开始,但您的函数返回HTML字符串,因此它更像是一个
视图
函数,因此您可以忽略它

现在,您应该考虑什么最能描述返回的字符串,在我看来,类似于“MusicProfile”或“MusicDetails”


顺便说一句,你的报价有冲突。

+1因为你提出了这样一个面向最佳实践的问题,而不是更常见的“ZOMG HERES MY CODE WHY IT NOT WORK”垃圾。