소스 가독성 높이는 방법

void f() {
TextHandler t;
t.sendText(“Hello, world”, true);
}

class TextHandler {
public:
void sendText(const std::string& msg, bool sendNewLine);
};

 

소스 분석할때 true가 무었인지 찾아보고 의도를 파악해야 하지만, 아래와 같이 처리하면 바로 알아볼 수 있음

 

class TextHandler {
public:
enum NewLineDisposition { sendNewLine, noNewLine };
void sendText(const std::string& msg, NewLineDisposition newLineDisposition);
};

void f(){
TextHandler t;
t.sendText(“Hello, “, TextHandler::noNewLine);
t.sendText(“world”, TextHandler::sendNewLine);
}
이제 f() 함수는 그 자체로 개발자에게 코드의 의미를 전달할 수 있습니다. 즉 self-documenting되어 있습니다.

Refactoring시에 적용함으로써 코드의 readability와 maintainability를 높일 수 있을것입니다.