사수한테 칭찬받는 읽기 좋은 함수, 변수명 잘 짓는 법
혹시 코드를 작성하다가 변수명을 어떻게 지을지 고민해 본 적이 있으신가요?
코드의 기능 구현만큼이나 중요한 것이 바로 명확하고 읽기 쉬운 네이밍을 하는 것이라고 생각합니다.
국내뿐만 아니라 해외에서도 네이밍에 대한 어려움은 똑같은 것 같은데요, 이런 밈이 있을 정도로 많은 프로그래머들이 골치 아파하는 부분인 것 같습니다.
변수명 관련 개발자 밈잘 지은 함수명이나 변수명은 코드의 가독성을 높여줄 뿐만 아니라, 팀원들과의 원활한 협업에도 큰 도움이 됩니다.
그래서 이번 시간에는 알아두면 사수에게 칭찬을 받을 수도 있는 함수, 변수명 잘 짓는 법에 대해서 알아보도록 하겠습니다.
1. 명확하게 사용자의 행동을 나타내는 동사 사용하기
함수나 메서드는 특정 동작을 수행하기 때문에, 동사를 사용하면 그 기능을 명확하게 전달할 수 있습니다.
예를 들어 데이터를 불러오는 함수는 loadData(), 요소를 추가하는 함수는 addItem()와 같이 동사로 시작하는 이름을 사용합니다. 이렇게 하면 함수가 어떤 행동을 수행하는지 한눈에 알 수 있어 코드의 가독성이 향상됩니다.
2. 상태나 특성을 나타나는 형용사 사용하기
변수나 속성의 이름을 지을 때 형용사를 활용하면 그 상태나 특성을 더욱 명확하게 전달할 수 있습니다. 예를 들어, 사용자가 활성화되었는지를 나타내는 변수는 isActive, 데이터가 유효한지를 체크하는 변수는 isValid와 같이 명명할 수 있습니다.
이러한 형용사 사용은 특히 boolean 타입의 변수에서 유용하며, 코드의 의미를 직관적으로 파악하게 도와줍니다. 또한 형용사를 포함한 이름은 조건문 작성 시에도 가독성을 높여줍니다. 예를 들어 if (isCompleted)라는 조건문은 해당 작업이 완료되었는지를 바로 알 수 있게 해 줍니다. 따라서 변수의 상태나 특성을 강조하고 싶을 때는 적절한 형용사를 사용하여 명확하고 읽기 쉬운 코드를 작성해 보세요.
3. 변수나 요소의 데이터 유형을 나타내는 명사 사용하기
변수나 요소의 이름에 데이터 유형을 명시하는 명사를 포함하면 코드의 가독성이 크게 향상됩니다. 예를 들어, 사용자 정보를 저장하는 변수는 userData, 유저의 상태를 나타내는 변수는 userState와 같이 명사로 데이터의 종류를 나타낼 수 있습니다.
이러한 명명 방식은 코드를 읽는 사람이 해당 변수가 어떤 데이터 유형을 가지고 있는지 즉시 이해할 수 있게 해 줍니다. 특히 복잡한 프로젝트나 대규모 팀에서 작업할 때, 명확한 명사 사용은 불필요한 혼동을 줄이고 버그를 예방하는 데 도움이 됩니다.
또한, 데이터 타입을 명시함으로써 타입스크립트 같은 정적 타입 언어에서 타입 추론이 용이해져 개발 효율이 높아집니다. 변수나 요소를 정의할 때는 그 데이터의 유형이나 목적을 나타내는 명사를 활용하여 더욱 명확하고 유지 보수가 쉬운 코드를 작성해 보세요.
4. 역할과 패턴을 명확히 하는 용어 사용하기
함수나 변수의 이름에 그들의 역할이나 디자인 패턴을 나타내는 용어를 포함하면 코드의 이해도와 유지 보수성이 크게 향상됩니다. 예를 들어, 콜백 함수를 정의할 때는 fetchDataCallback()처럼 이름에
callback을 포함시켜 해당 함수가 콜백임을 명확히 할 수 있습니다.
이처럼 특정 상황에 명확인 단어를 사용하는 것 만으로도 가독성이 올라가고 의도를 명확히 할 수 있습니다.
다른 사람과 함께 프로그래밍을 하고 있다면, 다른 사람이 내 코드를 읽고 잘 이해하게 하는 것도 좋은 개발자의 자세라고 생각합니다.
이 외에도 airbnb의 style guide 같은 문서를 찾아보셔도 큰 도움이 되실 것 같습니다.
저희 더컴퍼스는 하나의 웹사이트를 만들때에도 이런 명확한 기준을 바탕으로 좋은 프로덕트를 만들기 위해 다양한 노력하고 있습니다.
이런 노력들이 바탕이 되어 더컴퍼스는 60여개 이상의 관공서, 스타트업, 유튜버 및 유수기업 홈페이지 및 프로젝트 개발을 성공적으로 수행하였으며, 단순하고 일반적인 홈페이지가 아닌, 담당자님의 철저한 니즈 분석과 소통을 통해 꼭 맞는 웹사이트를 제작해드리고 있습니다.
직접 웹페이지를 만드실 때 어려움을 느끼시거나 전문가의 조언이 필요하시다면 언제든 편하게 연락해주세요.
