在註釋中使用字符串常量

Question

我看到一篇Java文章，表示最好在註釋中使用字符串常量（您可以看到文章here）。爲什麼這是一個好習慣？

Answer 1

最明顯的用法是找到對常量的所有引用比查找所有出現的字符串更容易。您的IDE將立即幫助您與前者，但後者您需要自己做。

然後，如果您需要更改該值（始終如一，無處不在），還存在可維護性問題。

Answer 2

使用常量總是比直接使用字符串文字要好，因爲信息只能在代碼中使用一次。如果在兩個不同的位置使用字面值"foo"，則有可能更改其中一個位置並忘記更換另一個位置。這可能會破壞你的代碼。

在註釋中相同甚至更重要。註釋通常僅與特定環境有關。在理想的世界中，我們有100％的測試覆蓋率，所以問題會很快發現。在現實生活中，單元測試通常在不依賴於代碼中編寫的某些註釋的環境中運行，因此您只會在實際環境中看到問題，而這可能是工具晚了。