选择有效的函数名称

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

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