깔끔한 코드 팁: 같은 개념에 같은 이름을 사용하세요.

내가 항상 말했듯이 이름을 짓는 것은 어렵다. a previous article에서 이에 대해 이미 이야기했습니다.

간단하고 일관성 있는 사전을 만들면 동일한 이름으로 동일한 아이디어를 나타내므로 클래스 이름이 더 좋아집니다. 이렇게 하면 코드 가독성과 검색 가능성이 향상됩니다. 또한 클래스 이름만 봐도 그 의미를 파악할 수 있습니다.

유사한 작업을 수행하는 3개의 개체가 있다고 가정합니다. 외부 소스에서 일부 콘텐츠를 다운로드합니다.

class YouTubeDownloader {    }

class TwitterDownloadManager {    }

class FacebookDownloadHandler {    }

여기서는 동일한 개념을 사용하기 위해 Downloader, DownloadManager, DownloadHandler라는 3개의 단어를 사용하고 있습니다. 왜??

따라서 유사한 클래스를 보고 싶다면 IDE에서 "다운로더"를 검색할 수도 없습니다.

해결책? 동일한 개념을 나타내기 위해 동일한 이름을 사용하십시오!

class YouTubeDownloader {    }

class TwitterDownloader {    }

class FacebookDownloader {    }

그렇게 간단합니다! 약간의 변경만으로도 코드의 가독성과 사용성을 크게 향상시킬 수 있습니다!

따라서 PR을 검토할 때 이러한 작은 문제도 고려하십시오.

결론

공용 사전은 오해 없이 코드를 이해하는 데 도움이 됩니다. 물론 이 팁은 클래스 이름뿐만 아니라 변수도 참조합니다. 개체의 동의어를 사용하지 마십시오(예: 비디오 및 클립). 동의어 대신 더 구체적인 이름을 사용하세요(동영상 대신 YouTube동영상).

다른 아이디어가 있습니까?

👉 토론하거나 아래 댓글 섹션에서 논의합시다!

🐧 이전에 Code4IT에서 본 🐧