🇩🇪 변수명을 만들 때는 독일 사람처럼 // 독일식 표기법

독일에 살고 있으니, 첫 게시글은 독일어와 관련된 이야기를 적어볼까 합니다. 독일어 사전에 표기된 가장 긴 단어는 자동차 책임배상 Kraftfahrzeughaftpflichtversicherung (크라프트파초이그 -하프트플리시트-페어지셔룽)라고 합니다. 발음 조차도 힘든데요. 사전에 등록되지 않았지만 무료 79글자에 육박하는 단어도 있습니다. 예를들면 Donaudampfschiffahrtselektrizitätenhauptbetriebswerkbauunterbeamtengesellschaft（도나우담프쉽팔츠일렉트리치테텐하우프트베트리브스베르크바우운터베암텐게젤샤프트, 한국어로 도나우 기선 전기사업 본공장 공사부문 하급관리조합) 같이요. 이처럼 독일어는 단어와 단어가 합쳐진 합성어에는 띄어쓰기를 하지 않는 특징이 있습니다. 어쩐지 단어자체도 마치 프로그래밍에서의 변수명 같이 보이죠? 굳이 불편하더라도 명시적이며 구체적으로 표현하고자 하는 독일 사람들의 언어적 습관 때문에 유럽에서는 클린 코드를 논할 때 '독일사람처럼 변수 이름을 지어라'고 말합니다. 이를 독일식 표기법이라고 부른답니다. 과거에는 헝가리안 표기법처럼 접두어/타입명 등을 사용해 변수명을 무조건 최대한 짧고 간결하게 쓰는 것이 유행했는데요. 최근에는 변수, 함수 등 이름에 암호화 같이 보이는 축약어 사용을 최대한 지양하라고 말합니다. 단어 수가 꽤 길더라도 구체적이고 명시적으로 작성하는 것이 코드 가독성을 높인다는 이유이지요. 이를 테면 파일을 여는 메서드 이름을 fopen 대신 openFile을 사용하고, 유효성 에러를 발생시키는 throwVE 대신 throwValidationError을 사용하는 것입니다. 간단한 함수도 Foo/Bar/Baz 사용하지 말라고 합니다. 실제로 저는 실무에서 자바스크립트 reduce, filter, map 같은 iterators 에서도 acc, cur, i, n와 같은 변수명을 최대한 사용하지 말라고 여러번 피드백을 받았습니다. UI 요소도 btn 말고 button이라고 하는 것이 바람직하고요. 그럼 아래 코드를 보고 독일식 표기법을 적용해 볼까요? 아래 함수를 어떻게 개선해 볼 수 있을까요? const one = (a) => { let n = a .split('\n') .map(x => parseInt(x)); for (let i = 0; i x == foo); if (n.filter(x => x == foo).length == 1) { return n[i] * bar; } } } 이 함수는 문자열 입력값 중 정수만 추출하여 배열을 만든 다음, 두 개의 숫자가의 총 합이 2020이 되는 요소를 찾고 두 합의 곱을 계산하네요. 연산 과정이 꽤 복잡합니다. 이제 이 함수에 독일식 표기법을 적용해볼까요?. const findProductOfTwoEntriesWhoseSumIs2020 = (input) => { let numbers = input .split('\n') .map(x => parseInt(x)); for (let i = 0; i x == partOneOf2020); if (numbers.filter(x => x == partOneOf2020).length == 1) { return numbers[i] * partTwoOf2020; } } } 애매모호한 함수 이름인 one를 findProductOfTwoEntriesWhoseSumIs2020으로 바꾸었어요. 함수 이름이 꽤 길어졌지만 함수 본문을 읽지 않고도 함수가 어떤 일을 하는지 바로 이해할 수 있게 되었습니다. 이처럼 목적과 의도를 명확하게 작성하는 것이 독일식 표기법이라고 합니다. foo와 bar같은 랜덤한 변수 이름도 partOneOf2020, partTwoOf2020으로 바꾸어 각 변수가 무엇을 지칭하는지 알 수 있게 되었습니다. 함수의 인자 a도 input으로 바꾸어 어떤 데이터인지 알 수 있고요. 암호 같은 변수 이름을 해석하지 않아도 되고요. 작성된 그대로를 읽어도 누구나 이해할 수 있게 되었어요. '평범한 언어(영어)'로 말이죠. ------- 참고 링크 https://chrisdone.com/posts/german-naming-convention/ https://slides.com/adriennetacke/documentation-the-missing-pieces/fullscreen#/20