选择有效的函数名称

Question

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

例如：

//function formats array
...
$returnStr = "<span class='bold'>Entrance</span>customerData['entrance']";

我问的原因是，我想出的任何函数名似乎都太冗长或不清楚其含义。 我必须维护大量代码，因此我试图选择有效的名称，以便在我重新访问代码时可以快速了解发生了什么。

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

Answer 1

在这种情况下，没有黑色或白色。 但我认为最佳做法应该是：

因此，您不必考虑“等等，X和Y的函数名称是什么？” 而且您不必编写太多代码，例如： printMusicVenueFromArray 。

“逻辑”和“舒适”方面都是主观的，可能在一个人与另一个人之间是不同的，因此，只有您自己从事该项目-做正确的事。

当您有一个开发人员团队在一个项目上工作时，请考虑先制定一些准则。

首先用单词描述函数，什么是输入，什么是输出。 考虑一下您的代码中已经存在的其他具有相似名称的函数（您不要感到困惑）。

根据您的描述：

函数基本上将包含客户出勤信息的数组数据重组到音乐场所（例如时间，日期，入口等）。 该函数接收数组数据，并返回格式化为包含HTML结构的字符串格式的信息。

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

输出（返回）格式化为包含HTML结构的字符串的信息。

通常，当我编写返回某些内容的函数时，我将从get开始，但是您的函数返回HTML字符串，因此它更多是一种view函数，因此您可以忽略它。

现在，我应该考虑最能描述返回的字符串的内容，例如“ MusicProfile”或“ MusicDetails”。

顺便说一句，您的报价有冲突。