Magic literal대신에 상수 혹은 변수를 활용해야 합니다

[hannut91]

문제

Magic literal이라고 부르는 문자열 혹은 숫자를 사용하여, 이해하기 어렵다.

예시

const circumference = 2 * r * 3.141592

해결

Magic literal이라고 부르는 숫자 혹은 일반 문자열은 코드를 읽는 사람이 값의 의미를 모르면 그 값 자체로는 의미를 명확하게 알려주지 못합니다.

예를들어서 원의 둘레를 구하기 위해서는 반지름 * 2 * 파이를 계산해야 하는데 다음과 같이 작성되어있다고 생각해보죠

r * 2 * 3.141592

그런데 실수로 숫자를 잘못 쓸 수도 있겠죠

r * 2 * 3.141591

그러면 알아차리기가 어렵습니다. 그렇다면 상수로 선언한다면 다음과 같이 작성했겠죠.

Int PI = 3.141592;
r * 2 * PI;

그러면 코드를 읽는 사람에게 값이 의미 하는 바를 드러낼 수 있고, 중복되어 사용하거나 실수로 작성되는 것을 막을 수 있습니다.

See also

• https://refactoring.com/catalog/replaceMagicLiteral.html