Table of contents
소프트웨어(S/W)를 개발하는 사람들은 함수나 변수의 이름을 어떻게 정해야 할지, 고민이 되는 경우가 종종 있습니다. 생각해보면 별것 아닌 일인데 다른 함수나 변수의 이름과 겹치지 않고, 공통적인 분위기를 해치지 않으면서, 한눈에 들어오는 이름을 짓는 것은 꽤나 어려운 일이지요.
1인 개발자(또는 기업)라면 그나마 괜찮지만, 여러 사람과 협업하는 환경이라면 다른 사람이 보았을 때, 함수와 변수가 무엇을 의미하는지 한눈에 들어오는 조건도 추가되어야 합니다.
직장생활을 하다 보니, 아래와 같이 4가지 조건이 만족되면 매우 좋은 이름이라고 생각하게 되었습니다.
- 공통성
- 유일성
- 가시성
- 가독성
그런데, 위의 조건들을 만족하며 개발하기도 어려운데, 영어의 약어까지 고민해야 한다면, 토종 한국인 개발자로서는 매우 골치 아픈 일이 되어버립니다. :-(
알고리즘이나 전체 구조를 고민할 시간에 어느 순간 나도 모르게 작명을 위해 많은 시간을 할애하고 있지요..
이러한 사람들을 위해, 약어를 검색할 수 있는 웹사이트를 추천합니다. 아래 그림과 같이 메인 페이지는 심플한 편입니다. 검색어와 검색 옵션과 같이 크게 두 가지로 구분할 수 있습니다. 약어(Abbreviation >> Term)로 검색하면 약어 입력 시 단어를 검색해주고, 반대로 단어(Term >> Abbreviation)로 입력하면 약어를 검색해줍니다.
다음은, Water를 예상하고 Water의 약어인 WTR를 약어 검색 옵션으로 검색한 모습입니다. Water, Windows Trace Remover 등이 검색됨을 확인할 수 있네요.
반대로, Water를 단어 검색 옵션으로 검색한 화면입니다. W, AQUA, AQ, H2O, WTR 등등이 검색되었습니다. 이 중에서 원하는 약어를 함수나 변수명에 녹아내리면 가시성과 가독성을 높이는데 큰 도움이 되겠죠? 무엇보다 약어에 대해 고민하지 않아서 매우 좋은 사이트라고 생각합니다.
'소프트웨어 > 소프트웨어 공통' 카테고리의 다른 글
S/W 개발 관련 사이트 모음 (0) | 2023.07.20 |
---|---|
펌웨어/임베디드 소프트웨어 개발, 잘 안 풀릴 때 읽어볼 만한 글 (0) | 2022.06.15 |
Floating과 Node-Locekd License(플로팅과 노드락 라이선스) (0) | 2022.06.15 |
코딩 테스트 사이트 후기 (0) | 2022.02.13 |
동기/비동기(Synchronous/Asynchronous) 개념 정리 (0) | 2021.12.29 |