프로그래밍 팁

함수 이름 짓기

좋은 함수 이름을 고르는 것은 좋은 코드를 작성하는 데 꼭 필요한 부분이에요. 함수 이름을 지을 때는 다음 권장 사항을 살펴봐요.

의미 있는 함수 이름을 골라요

함수 이름을 지을 때는 그 함수가 무엇을 하는지 분명해야 해요. 예를 들어 get(studentId, subject)라는 함수는 이름만으로는 무엇을 하는지 알기 어려워요. 학생의 과목 성적을 가져오는 건지, 등록 상태를 가져오는 건지 헷갈리죠. getStudentGrade(studentId, subject)라는 이름이 훨씬 나아요. 함수가 하는 일을 정확하게 알려주니까요.

함수 이름을 너무 길게 짓지 않아요

함수 이름이 너무 길어지지 않도록 주의해요. 예를 들어 checkStudentFailOrPassOrMeritOrDistinction(mark)는 불필요하게 긴 함수 이름이에요. 이름이 길수록 기억하기도 어렵고, 화면에서 차지하는 공간도 커져요.

함수 이름을 너무 짧게 짓지 않아요

반대로, 함수 이름을 너무 짧게 지으면 읽는 사람을 헷갈리게 할 수도 있어요. 예를 들어 checkFPMD(mark)는 'FPMD'가 무슨 뜻인지 바로 알아보기 어려워서 좋지 않은 함수 이름이에요.

누구나 이해할 수 있는 이름을 써요

함수 이름은 코드를 읽는 누구나 이해할 수 있어야 해요. 예를 들어 DeathStar()처럼 생뚱맞은 함수 이름은 본인에게는 재미있을지 몰라도, 함수의 목적이 이름에 드러나지 않아 코드를 읽는 다른 개발자들을 혼란스럽게 할 수 있어요.

동작 이름을 짓는 규칙은 하나로 정해요

같은 일을 하는 동작에는 한 가지 이름 규칙을 끝까지 지켜요. 예를 들어 학생의 이름을 가져오는 함수를 getStudentName()이라고 이름 지었다면, 학생의 성적을 가져오는 함수에는 다른 동사를 쓰면 안 돼요 (예: retrieveStudentGrade()).

같은 단어를 두 가지 뜻으로 쓰지 않아요

예를 들어 두 수를 더하는 연산에 이미 add라는 이름을 붙였다면, 여러 항목을 컬렉션에 넣을 때도 계속 add를 쓰지 마세요. 대신 insert나 append를 사용해요.