選擇有效的函數名稱

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

順便說一句，你的報價有衝突。