选择有效的函数名称
Choosing effective function names
我正在寻找关于编写好的函数名称作为我正在开发的网页的一部分的建议。它在 PHP 中编码，该函数基本上将保存客户出席信息的数组数据重新组合到音乐场所（例如时间、日期、入口等）。该函数接收数组数据和 returns 格式化为包含 HTML 结构的字符串的信息。
例如：
//function formats array
...
$returnStr = "<span class='bold'>Entrance</span>customerData['entrance']";
我问的原因是我想出的任何函数名称似乎都过于冗长或者不完全清楚它的含义。我必须维护很多代码，所以我尝试选择有效的名称，这样当我重新访问代码时，我可以快速掌握正在发生的事情。
任何在线资源或个人见解都将不胜感激。
在这种情况下没有黑色或白色。但我认为最佳做法应该是：
- 逻辑 - 描述函数的作用
- 舒适 - 简明扼要
因此您不必考虑 "Wait, what was the name of the function that does X and Y?"，也不必编写太多代码，例如：printMusicVenueFromArray.
"logical" 和 "comfortable" 方面都是主观的，可能因人而异，所以只要只有你在那个项目上工作——做你认为正确的事情。
当您有一个开发团队处理单个项目时，请考虑先制定一些指导方针。
首先用文字描述函数，输入是什么，输出是什么。
考虑您的代码中已存在的具有相似名称的其他函数（您不想混淆）。
根据您的描述：
function basically reassembles array data holding customer attendance
information to a music venue (example time, date, entrance, etc) . The
function takes in array data and returns the information formatted as
a string that includes HTML structuring.
输入
将客户出席信息保存到音乐场所的数组数据
输出
(return) 格式化为包含 HTML 结构的字符串的信息。
通常当我写 return 的函数时，我会从 get 开始，但是你的函数 returns HTML 字符串所以它更像是一个 view 函数所以你可以忽略它。
现在你应该考虑什么最能描述 returned 字符串，在我看来，像 "MusicProfile" 或 "MusicDetails".
顺便说一句，你的引用有冲突。
我正在寻找关于编写好的函数名称作为我正在开发的网页的一部分的建议。它在 PHP 中编码，该函数基本上将保存客户出席信息的数组数据重新组合到音乐场所（例如时间、日期、入口等）。该函数接收数组数据和 returns 格式化为包含 HTML 结构的字符串的信息。
例如：
//function formats array
...
$returnStr = "<span class='bold'>Entrance</span>customerData['entrance']";
我问的原因是我想出的任何函数名称似乎都过于冗长或者不完全清楚它的含义。我必须维护很多代码，所以我尝试选择有效的名称，这样当我重新访问代码时，我可以快速掌握正在发生的事情。
任何在线资源或个人见解都将不胜感激。
在这种情况下没有黑色或白色。但我认为最佳做法应该是：
- 逻辑 - 描述函数的作用
- 舒适 - 简明扼要
因此您不必考虑 "Wait, what was the name of the function that does X and Y?"，也不必编写太多代码，例如：printMusicVenueFromArray.
"logical" 和 "comfortable" 方面都是主观的，可能因人而异，所以只要只有你在那个项目上工作——做你认为正确的事情。
当您有一个开发团队处理单个项目时，请考虑先制定一些指导方针。
首先用文字描述函数，输入是什么，输出是什么。 考虑您的代码中已存在的具有相似名称的其他函数（您不想混淆）。
根据您的描述：
function basically reassembles array data holding customer attendance information to a music venue (example time, date, entrance, etc) . The function takes in array data and returns the information formatted as a string that includes HTML structuring.
输入 将客户出席信息保存到音乐场所的数组数据
输出 (return) 格式化为包含 HTML 结构的字符串的信息。
通常当我写 return 的函数时，我会从 get 开始，但是你的函数 returns HTML 字符串所以它更像是一个 view 函数所以你可以忽略它。
现在你应该考虑什么最能描述 returned 字符串，在我看来，像 "MusicProfile" 或 "MusicDetails".
顺便说一句，你的引用有冲突。