[읽코좋코] 선언문을 블록으로 구성하라

우리 뇌는 자연스럽게 그룹과 계층구조에 따라 동작하므로, 코드 또한 이러한 방식으로 구성하면 읽기 좋다고 한다.

 

class FontendServer{
	pubilc:
		FrontedServer();
                void ViewProfile(HttpRequest* request);
                void OpenDatabase(string location, string user);
                void SaveProfile(HttpRequest* request);
                string ExtractQueryParam(HttpRequest* request, string html);
                void ReplyOk(HttpRequest* request, string html);
                void FindFriends(HttpRequest* request);
                void ReplyNotFound(HttpRequest* request, string error);
                void CloseDatabase(string location);
                ~FrontendServer();
};

- 클라이언트에서 서비스를 제공하도록 전면에 배치된 서버를 위한 C++ 클래스의 메소드 선언문이 있을때, 읽는 사람이 쉽게 파악할 수 있는 레이아웃 구성이 되지 않았다.

 

class FontendServer{
	pubilc:
	FrontedServer();
        ~FrontendServer();
        
        //핸들러들
        void ViewProfile(HttpRequest* request);
        void FindFriends(HttpRequest* request);
	void SaveProfile(HttpRequest* request);
        
        
        //질의/응답 유틸리티
        string ExtractQueryParam(HttpRequest* request, string html);
        void ReplyOk(HttpRequest* request, string html);
        void ReplyNotFound(HttpRequest* request, string error);
        
        //데이터베이스 핼퍼들
        void OpenDatabase(string location, string user);
	void CloseDatabase(string location);
};

- 코드 줄 수가 늘어났지만 더 읽기 쉽게 레이아웃이 구성되어 있다.

- 네 개의 큰 섹션을 개략적으로 확인이 가능하며, 필요하면 각 세션에 자세한 내용을 살펴볼 수 있다.