개발할 때 변수 정하는 법

까마귀 발톱·2024년 6월 22일

개발일상

목록 보기
6/16

객체 내의 변수라도 가독성을 높이기 위해 명확한 이름을 사용하는 것이 중요하다. 예를 들어, Shop 클래스에 변수 이름을 id라고 지을까 shopId라고 지을까 고민된다면, shopId처럼 구체적으로 작성하는 것이 좋다. 변수 이름을 shopId라고 하면 어떤 클래스의 변수인지 쉽게 구분할 수 있기 때문이다.

shopId라고 쓰면 데이터베이스나 커뮤니케이션에도 유리하다. shopId가 클래스 내 변수가 아니라 데이터베이스 테이블의 컬럼으로 사용될 때도 마찬가지다. 의사소통 시에도 shopId라고 하면 어떤 데이터를 다루고 있는지 명확히 알 수 있다. id라고만 하면 데이터베이스에 따라 id라는 이름을 사용할 수 없는 경우도 있다. 설령 사용 가능하다고 하더라도 id라고 컬럼명을 지으면 id가 어떤 테이블에 들어있는지 알아야 정확한 의미를 알 수 있다.

클래스나 데이터베이스 테이블 모두 코드로 사용할 때는 별칭(alias)으로 쓰기 때문에 id로 쓰게 되면 실제 의미가 무엇인지 알기 불편하다.

의사소통에서도 변수명을 명확히 하면 협업 시 큰 도움이 된다. shopId로 이름을 지정하면 어떤 데이터를 다루고 있는지 즉시 알 수 있다. id로 짓게 되면 어디서 쓰는 값인지 매번 귀찮게 설명해야 할 수 있다.

마찬가지 맥락으로 약어는 함부로 쓰지 않는 것이 좋다. 약어를 사용하면 코드를 읽는 사람이 그 의미를 추측해야 할 수 있다. 가능하면 풀네임을 사용하여 가독성을 높이는 것이 좋다.

단, 반복적으로 사용하는 개념의 경우 약어를 사용하는 것이 효율적일 수 있다. 예를 들어, 배송 시스템을 만드는 프로그램에서 "Estimated Time of Arrival"라는 용어는 매우 반복적으로 사용될 수 있다. 이를 직관적으로 사용하기 위해 풀어쓰기보다는 약어로 "ETA"를 쓰는 것이 적합할 수 있다.

물론, 이러한 명명 규칙은 도메인마다 다를 수 있다. 도메인에 따라 그만한 이유가 있거나, 이미 굳어지고 익숙해진 명명 규칙이 있을 수 있다. 그러한 경우에는 기존의 규칙을 따르는 것이 좋다.

결론적으로, 명확한 변수명과 클래스명을 사용하면 코드의 가독성을 높이고, 협업 시 의사소통을 원활하게 할 수 있다. 변수와 클래스의 이름은 코드의 일관성과 이해도를 높이는 중요한 요소이므로, 신중하게 선택해야 한다.

profile
딴생각이 많은 10년차 개발자

0개의 댓글