基於流行度的命名功能

Question

您需要兩個功能：
1.從數據庫檢索純文本。
2.基於1，檢索富文本-具有新行，字體樣式等。

您希望功能2比功能1更加有用。

您將命名為1 text（）還是2-rich_text（）還是將更簡單的text（）命名為2，因為它會更受歡迎，並為1使用諸如plain_text（）之類的東西？

更為籠統的問題是-命名功能時您是否考慮其預期的“受歡迎程度”？

Answer 1

不，我不認為該功能很受歡迎。 最好為兩個函數都使用描述性名稱（例如，一個是plain_text() ，另一個是rich_text() ）。

我認為最好為所有功能使用相對特定的名稱，因為使用更通用的名稱1.）不會通過讀取名稱讓用戶過多了解功能的作用，並且2.）可能導致混淆。

當然，如何命名函數是您的選擇：我只是建議您給它們提供一些描述性的名稱，並一致地命名它們（並對參數進行排序）。

我最討厭的就是使用每個函數名都簡短且含糊不清的API進行編程（即使現在我已經習慣了PHP的字符串函數，PHP的字符串函數都是那樣的strstr和strtok並不是它們所做工作的直觀名稱）。

Answer 2

有時，如果代碼將被廣泛使用，則值得考慮普及性。 自然語言中的常用詞往往簡短。

但是，除非您認為自己正在編寫下一個UNIX，否則最好使名稱具有描述性，而不用擔心長度。

我會去找getPlainText()和getRichText() 。

Answer 3

根據經驗，我總是根據函數的功能來命名它們。 如果我不知所措，則將函數命名為retrieve_plain_text() ，將函數命名為retrieve_rich_text() 。 現在，我可以看一下其中一個函數的名稱，並立即對該函數的功能有一個基本的了解：檢索（從某種東西（在這種情況下為數據庫）獲取）純/豐富的（類型）文本。