過於複雜的命名會導致混亂
TL;DR:命名很難,不要因為不必要的意外複雜性而讓它變得更難。
不清晰、誤導性、含糊和不明確的名稱
冗餘術語
令人困惑的抽象
神祕縮寫
簡化命名約定
確保一致性
避免不必要的行話
依行為使用描述性名稱
保持術語一致
路德維希·維根斯坦 (Ludwig Wittgenstein) 認為,許多混亂是由語言濫用引起的。
當您的名稱過於複雜、混合隱喻或使用不一致的術語時,就會發生這種情況。
當你不清楚地命名類別、方法或變數時,你就創造了一個其他人難以導航的語言迷宮。
這會導致錯誤,使維護變得更加困難,並導致團隊沮喪。
public class AbstractDataHandlerManager { private String dtStr; public void execProcessingOps(String input) { if (dtStr != null && !dtStr.isEmpty()) { // process } } }
public class SETIProcessor { public void processSignal(String input) { // process } } }
[X] 手冊
當名稱開始變長,或經常看到「Abstract」、「Manager」、「Handler」、「Helper」或「Data」時,您可以檢測到這種氣味。
另一個標誌是您必須向其他開發人員解釋名稱的含義,例如在程式碼審查中。
[X] 初學者
人工智慧生成器通常透過產生冗長且通用的名稱來創建這種氣味,這些名稱試圖涵蓋所有可能的上下文。
他們是許多領域的專家並編寫程式碼,但除非得到指示,否則他們通常不會同時做這兩件事。
人工智慧生成器有時可以透過簡單的重構指令(例如「簡化名稱」或「刪除冗餘術語」)來修復這種氣味,但很難進行更深入的上下文理解。
程式碼中的語言混亂會導致不必要的複雜性。
使用清晰、一致且直接的命名,讓您的程式碼更易於閱讀和維護。
維根斯坦的語言混亂概念
程式碼味道是我的觀點。
照片由 Mimi Thian 在 Unsplash 拍攝
清晰語言的最大敵人是不真誠。
喬治‧歐威爾
本文是 CodeSmell 系列的一部分。
以上是代碼氣味 - 語言混亂的詳細內容。更多資訊請關注PHP中文網其他相關文章!