选择有效的函数名称

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”。

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