깔끔하고 읽기 좋은 함수명, 변수명 짓기 팁 7가지!

<출처> Unsplash

프로그래밍을 하면서 의외로 어려운 부분은 바로 함수 이름, 변수 이름 등의 각종 네이밍입니다. 따라서 최근에는 함수명 짓기와 변수명 짓기를 자동으로 해주는 사이트도 생겨나고 있는데요. 이러한 사이트를 적극 활용하려면 변수명 규칙이나 카멜 케이스 등의 함수명 변수명 짓기 팁에 대해서 미리 숙지를 하고 있는 것이 중요합니다. 오늘은 변수명과 함수명을 깔끔하고 이해하기 쉽게 만드는 꿀팁 7가지에 대해서 알려 드리려고 합니다.

1. 깔끔하고 읽기 좋은 함수명, 변수명 짓기 팁 7가지!

<출처> Unsplash

Tip 1. 해당 언어에 맞는 변수명 규칙을 먼저 숙지 하기

함수명 짓기, 변수명 짓기 팁 첫 번째는 해당 언어의 변수명 규칙을 먼저 숙지하는 것입니다. 모든 언어에는 변수명 규칙이 있습니다. 아무리 잘 지은 변수 이름과 함수 이름이라 하더라도 해당 언어의 변수명 규칙에서 벗어나면 변수 이름으로서의 기능을 할 수 없습니다. 그렇기 때문에 먼저 변수명 규칙에 대해 정확히 숙지를 하고 나서 변수 이름과 함수 이름을 짓는 것이 필수적입니다.

Tip 2. 이름에 의미 넣기

함수명 짓기, 변수명 짓기 팁 두 번째, 변수명 규칙을 알았다면 이제는 함수 이름과 변수 이름에 의미를 부여하여 지어야 합니다. 즉 이름에 해당 변수와 함수에 대한 정보를 담아내야 한다는 것입니다. 함수 이름 혹은 변수 이름이 길어지더라도 다른 사람이 이름만으로 바로 이해할 수 있게 쉽고 명료한 단어로 네이밍을 하는 것이 중요합니다.

이름에 의미를 부여할 때, 여러 가지로 해석 될 수 있는 단어는 피해야 하며, 자신만이 알아볼 수 있는 단어를 사용하는 것 또한 피하는 것이 좋습니다. 도메인 줄임말과 같은 경우도 마찬가지 입니다. 예를 들어 database를 DB로 줄이는 것은 모두 이해할 수 있으니 괜찮지만, User Name List를 UNL 등으로 자신만이 알아볼 수 있는 임의의 단어로 사용하는 것은 지양해야 합니다.

Tip 3. 함수 이름에 함수가 하는 일을 정확히 드러내기

함수명 짓기, 변수명 짓기 팁 세 번째는 함수 이름에 함수가 하는 일을 정확히 드러내야 한다는 것입니다. 함수는 한 가지 일만 수행 해야 하며, 함수의 역할을 이름에 정확히 표현해주어야 합니다. 그렇기에 함수가 두세가지 일을 하면서 그 중 하나만 이름에 표현을 하는 경우, 혹은 명확하지 않은 이름으로 표현을 하여 함수가 정확히 어떤 일을 수행하는지 이름만으로 파악하기 힘들다면, 함수명을 변경해주는 것이 좋습니다.

Tip 4. 자신에게 맞는 케이스 스타일 활용하기

<출처> 러닝스푼즈 자체 제작 이미지

함수명 짓기, 변수명 짓기 팁 네 번째, 자신에게 맞는 케이스 스타일을 활용하여 변수 이름과 함수 이름을 지으면 유용합니다. 케이스 스타일은 대문자와 소문자, 그리고 -, _ 를 활용하여 변수 이름 혹은 함수 이름의 가독성을 높이는 방법입니다.

케이스 스타일은 대표적으로 camelCase, PascalCase, snake_case, kebab-case 네 가지가 있습니다. 가장 많이 쓰이는 camelCase는 새로운 단어가 시작되는 시점의 첫 알파멧을 대문자로 표기하는 방법이며, PascalCase는 모든 단어의 첫 알파벳은 대문자, 다른 알파벳은 소문자로 표기를 합니다. snake_case와 kebab-case는 둘 다 소문자만 사용하되, 단어와 단어 사이에 - 혹은 _을 위치시켜 구분한다는 것이 다릅니다. 일반적으로 많은 개발자들이 CamelCase를 사용하지만, 언어에 따라 잘 사용되는 케이스 스타일이 있으니 확인하시고 참고하시기 바랍니다.

Tip 5. be동사와 일반동사 사용으로 변수 및 함수 구분하기

함수명 짓기, 변수명 짓기 팁 다섯 번째, 동사를 적극 활용하는 것입니다. be동사를 활용하는 경우, is로 시작하는 의문문 형태로 지으면 is만 보고 해당 이름이 변수임을 단박에 알아차릴 수 있습니다. 또한 함수는 수행과 관련되어 있기 때문에 해당 함수가 어떤 일을 수행할지 일반동사로 시작하는 함수 이름을 지으면 이해하기가 쉽습니다. 일반동사를 활용하면, 업데이트인지, 보여주는 것인지,설정하는 것인지, 가져오는지를 쉽게 이해할 수 있어 직관적인 이름이 됩니다.

Tip 6. 주석을 적극적으로 활용하기

함수명 짓기, 변수명 짓기 팁 여섯 번째, 주석을 잘 활용하는 것입니다. 사실은 주석이 필요가 없을 정도로 명확히 이해가 되는 이름이 가장 좋습니다. 그러나 함수의 이름보다 변수, 함수의 동작 원리가 훨씬 더 복잡한 경우, 주의점 혹은 추후의 개선점을 명시해 놓는 것은 협업에서 너무나 중요한 문제이므로, 혼자 코딩을 하는 경우에도 미래의 나 혹은 미래의 동료를 위해 주석을 성실히 달아두는 것이 좋습니다.

Tip 7. 보편적으로 사용되는 이름 짝 맞추어 사용하기

함수명 짓기, 변수명 짓기 팁 일곱 번째이자 마지막은 바로 보편적으로 사용되는 이름을 짝을 맞추어서 사용하는 것입니다. 개발자들이 보편적으로 사용하는 함수 이름을 위한 단어들이 있습니다.

예를 들어 사용자 데이터를 주기적으로 갱신하는 함수에 대해서는 이미 많은 개발자들이 사용하고 있는 이름인 UpdateUserDater라고 쓰는 것이 좋습니다. EditUserData라던가 ModifyUserData라고 쓰면 틀린 것은 아니나 바로 이해할 수 있는 부분을 시간을 걸리게 하는 좋지 않은 이름입니다.

또한 get 함수를 사용했으면 이후에 release 혹은 set 를 이름으로 사용하는 것이 일반적입니다. get함수 다음으로 오는 함수명을 set 대신 modify를 사용하면 틀리지는 않았으나 직관적으로 이해하기 어려운 이름이 됩니다. road는 unload와 더 잘 어울리므로 unload대신 delete 등의 다른 단어를 이름으로 사용하는 것을 피하는 것이 좋습니다. 이렇게 보편적으로 사용되는 이름의 짝을 맞추어서 사용하는 것이 좋습니다.

👉****데이터 분석, 파이썬과 R 어떤 언어로 입문해야 될까요?**** 👈

---

이번 아티클에서는 변수명 규칙 확인하기, 이름에 의미 부여하기 등 함수명 짓기 및 변수명 짓기 팁을 7가지를 소개해 드렸습니다. 위에서 알려드린 함수 및 변수 네이밍 팁을 활용하셔서 깔끔하고 이해하기 쉬운 함수 이름과 변수 이름을 짓는데 도움이 되었기를 바랍니다.

👇하루 20분, 한 달이면 코알못 탈출! 러닝스푼즈의 파이썬 기초 한달 완성 강의 바로 가기👇