Clean Code

참고 : 깨끗한 코드를 위한 5가지 팁.

 

특정 값을 받아 해당하는 연산을 수행한 뒤 결괏값과 비교한 boolean 값을 가지고 다른 메소드를 실행하여 값을 얻는 메소드. 해당 코드를 최대한 Clean Code에 가깝게 수정.

- 간단한 코드라 억지스러운 면이 없지 않아 있음..

1. 특정 상수들도 변수로 만들어 사용한다.

- inch 단위에서 centimeter 단위로 변경하기 위한 상수 2.54를 직접 넣으면 나중에 다른 개발자가 봤을 때 의미를 바로 알아차리기 힘들 수도 있다.

 

 

2. 메소드 명은 다른 사람이 봤을 때 한 번에 기능을 알 수 있어야 하고, 명사가 아닌 동사를 사용한다.

- toProcess라는 메소드는 너무 포괄적인 메소드 명이므로 해당 연산 뒤 문자열 값을 얻는다는 메소드 명으로 변경한다.

 

3. 메소드는 무조건 하나의 기능을 수행한다.

- inch를 centimeter로 변경하는 메소드, 값을 연산하는 메소드를 분리하여 만든다.

4. 너무 많은 인수를 사용하지 않는다.

- 불필요한 인수가 없는지 확인한다. (여기선 없다...)

5. boolean 값을 인수로 사용하지 않는다.

- boolean 값을 인수로 사용하지 않고 true, false 때 해당하는 메소드 명을 만든다.

6. 인수를 다른 사람이 이해할 수 있는 이름을 사용한다.

- i , c , r , o 등의 인수 이름은 다른 개발자가 봤을 때 의미를 바로 알기 힘들다.