리팩터링/냄새 (리팩터링할 시점)

냄새 1. 기이한 이름 (Mysterious Name)

developer-tj 2023. 2. 12. 15:37
반응형

"기이한 이름(Mysterious Name)"은 코드에서 이름만 보고는 의도를 파악하기 어려운 변수나 함수, 클래스 등을 가리키는 용어입니다.

이러한 이름은 코드의 가독성을 저해하며, 유지보수와 리팩토링을 어렵게 만듭니다.

 

"기이한 이름"으로 인한 문제는 다음과 같습니다.

  1. 가독성 저하: 이름만으로 변수나 함수의 역할이나 의도를 파악하기 어렵습니다.
    이로 인해 코드를 이해하는데 많은 시간과 노력이 필요해지며, 다른 사람들이 코드를 이해하는데 어려움을 겪을 수 있습니다.
  2. 유지보수의 어려움: 변수나 함수의 역할이 명확하지 않은 경우, 코드를 수정하거나 개선하는 것이 어려워집니다.
    이로 인해 새로운 기능을 추가하거나 버그를 수정하는 것이 더욱 어려워지며, 시간과 비용이 많이 들어가게 됩니다.

따라서 "기이한 이름"을 방지하기 위해서는 변수나 함수 등의 이름을 명확하고 의미 있는 이름으로 지정하는 것이 중요합니다.

 

좋은 이름을 가진 함수나 변수는 코드를 보지 않고 이름만으로 어떤 역할을 하는지 이해할수 있습니다.

 

함수

- 함수가 하는 역할을 주석으로 작성한 다음 해당 주석을 참고하여 함수 이름으로 만들어본다.

 

변수

- 범위가 넒은 변수 일수록 이름이 중요하다.

- 다이나믹 타입인 경우에 변수명에 타입을 넣는다. (auto 사용시 변수명에 타입을 알수 있도록 한다.)

 

이러한 이름을 사용하면 코드의 가독성이 좋아지며, 유지보수와 리팩터링도 용이해집니다.