[내일배움캠프] 계산기 구현 - 리팩토링

 현재 '계산기 구현`에 대한 요구사항을 모두 프로젝트에 반영하였다. 이번에는 해당 프로젝트에 요구사항이 제대로 반영되었는지 확인하고 필요하다면 수정하려 한다. 더불어 구현 때문에 미루어 두었던 'README.md' 파일도 수정하였다.

 

1. README.md

 다른 사람이 해당 프로젝트를 확인해도 쉽게 이해를 도울 수 있도록 READMD.md 를 작성해 두었는데, 이전에 없던 '목차' 와 '시스템 아키텍처' 를 추가하였다.

 

 

2. 코드 리팩토링(refactoring)

 기존에 사용하던 클래스, 메서드, 변수의 이름을 수정하고 기존에 작성해둔 주석도 수정하였다. '클래스/메서드 이름 수정' 에 대한 일부는 아래와 같다.

• ValidInputData → ValidInput : 입력 값의 유효성 검증 역할을 가진 클래스의 이름인데 유효성을 뜻하는 'Validation' 을 줄여 'Valid' 라고 표현한 만큼 '입력 값' 을 뜻하는 'InputData' 도 'Input' 으로 줄였다.
• calculatorNum  → calNum : 사용자가 선택한 '계산기 번호' 를 저장하는 변수명인데, 이름이 너무 길어 'calculator' 를 'cal' 로 줄였다.

 대체적으로 의도를 파악할 수 있는 선에서 이름의 길이를 줄이는 작업을 수행했다. 주석의 경우에는 의미 전달이 약하거나 의도가 불분명한 경우 삭제/수정 하는 작업을 진행했다. 수정한 코드의 내용은 여기에서 확인 할 수 있다.

 

 

3. 마무리

 요구사항을 전부 반영했고 다시 한 번 코드를 읽으며 확인하고 테스트도 진행해 보았다. 하지만 아직 고칠 점들이 더 보였는데 이 부분을 반영하여 개인적으로 'level04 계산기' 를 만들고자 한다.