选择有效的函数名称

时间:2015-04-30 14:20:05

标签: php coding-style naming code-cleanup

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

例如:

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

我问的原因是我提出的任何功能名称似乎都过于冗长或者并不完全清楚它的含义。我必须保留很多代码,所以我试图选择有效的名称,这样当我重新访问代码时,我可以快速掌握正在发生的事情。

任何在线资源或个人见解都将受到赞赏。

1 个答案:

答案 0 :(得分:2)

在这种情况下没有黑色或白色。但我认为最好的做法应该是:

  • 逻辑 - 描述功能的作用
  • 舒适 - 简短而重要

所以你不必考虑“等待,X和Y的函数名称是什么?”并且您不必编写太多代码,例如:printMusicVenueFromArray

“逻辑”和“舒适”两个方面都是主观的,可能因人而异,所以只要你在那个项目上工作 - 做正确的事情。

当您有一个开发人员团队处理单个项目时,请考虑先绘制一些指导原则。

首先描述单词中的函数,输入是什么,输出是什么。 考虑代码中已存在的具有相似名称的其他函数(您不希望混淆)。

根据你的描述:

  

功能基本上重新组装了持有客户出勤率的阵列数据   信息到音乐场所(例如时间,日期,入口等)。该   函数接收数组数据并返回格式为的信息   包含HTML结构的字符串。

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

<强>输出 (返回)格式化为包含HTML结构的字符串的信息。

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

现在你应该考虑一下最能描述返回字符串的内容,在我看来,像是“MusicProfile”或“MusicDetails”。

顺便说一下,你的报价发生冲突。