DAY 8

🔖 오늘 읽은 범위 : 4장 주석

<aside> 😃 책에서 기억하고 싶은 내용을 써보세요.

</aside>

• 나쁜 코드에 주석을 달지 마라. 새로 짜라, 주석은 필요악이다. (p.68)
• 내가 주석을 무시하는 이유가 무엇이냐고? 거짓말을 하니까.(p68)
• 코드로 의도를 표현하라(p.70)
• 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.(P.75, 뜨끔)

<aside> 🤔 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

</aside>

프로그래밍을 처음 시작했을 때에는 1990년대 후반이었는데, 친구들과 게임하는 것을 좋아해서 게임 만드는 데에 푹 빠져 있었을 때가 있었다. 320*200 해상도 2d부터, opengl이나 directx로 3d를 다루면서, 20대 초반까지는 나름 열심히 공부했었던 것 같다. 이 말을 꺼내는 이유가 그때 당시에는 프로그래밍 시작할 때.. 항상

/***********************************************************************
   Particle Engine - by pleed
   작성일: 20XX.XX.XX
************************************************************************/

이런식으로 헤더에 뭔가 정보를 주고 시작을 했었다. 나만 그랬던 것이 아니라, 각종 라이브러리 같은 것을 열어봐도 저런 식으로 헤더에 주석 작성하는 코드가 많았던 것으로 기억한다. 그때 당시에는 코드 버전관리를 나나, 주변에서는 잘 사용을 안(이라 썼지만 못)했기 때문이다. 지금은 IDE도 비약적으로 좋아졌고, 버전관리 시스템도 너무 좋으니, 저런 것들을 사용 할 필요가 없어졌다.

주석 달기는 중요하기 때문에, 주석을 무조건 달아야 된다고 생각했던 적이 있었다. 그래서 주석 달 때마다 항상 어떻게 주석을 써야 잘 쓸까 고민했었는데, 이제는 조금은 고민을 덜 수 있을 것 같다. 주석을 열심히 작성하는 것보다는 코드를 간결하게 만드는 것에 더 신경을 쓰는 것이 좋기 때문이다. 책에서는 그래서 주석은 필요악이라고까지 표현을 할 정도이다. 주석이 좋은 효과가 있는 것보다 나쁜 경우가 더 많기 때문이다. 그렇다고해서 주석이 아에 없으면 좋냐.. 하는 것은 또 아니기 때문에 주석을 꼭 필요할 때만 남기는 것이 좋음을 알게 되었다.

전반적으로 책 내용에서는 주석을 어떻게 잘 작성을 해라 하는 것은 없다. 필요한 케이스를 예를 들어, 어떤 경우에는 주석을 남기는 것은 좋은데 그마저도 조심히 남기라하는 것.

주석을 작성하지 말아야 하는 케이스가 주석을 작성해야 하는 케이스보다 훨씬 많다. 그만큼 주석 작성보다는 코드 간결에 신경을 쓰라는 것이 이 챕터의 결론이라 볼 수 있다.

나는 지금은 코딩과는 전혀 상관 없는 직장에 있기 때문에 많은 코드를 작성하는 사람은 아니지만, 최근에 줌클론 챌린지에 참여하면서, 이 엄청나게 핑퐁하는 이벤트들을 어떻게 정리를 잘 할 수 있을까.. 많이 고민을 했었다..

// 클라이언트가 방 참가 또는 방 만드는 것을 요청..
    socket.on('request_join_room', (roomName) => {
        const room = io.sockets.adapter.rooms.get(roomName);
        console.log(room);
        if (room && room.size !== 1) {
            // 방에 이미 두 사람이 있는 것..
            socket.emit('reject_join_room', roomName);
            return;
        }
        // 로비 나가고, 일단 방에 참가.
        socket.leave('lobby');
        socket.join(roomName);
        // 클라이언트에도 방에 참가했음을 알려줌.
        socket.emit('grant_join_room', roomName);
        // 존재하지 않는 방이면.. 로비에 있는 멤버들에게 방이 생겼음을 알려줌.
        if (!checkRoom(roomName)) {
            socket.to('lobby').emit('room_created');
        }
    });

위 코드가 서버 코드의 일부분인데, 클라이언트가 서버에 채팅룸 참가를 요청하였을 때 서버에서 이벤트 처리하는 코드이다. 이 코드를 어떻게 좀 정리하면서, 나중에 봤을 때 헷갈리지 않을까 고민해서 주석을 작성했는데.. 솔직히 쓸 데 없는 주석을 많이 넣은 것 같다.

위와 같이 소켓 이벤트 처리는.. 명명법이나 함수 챕터에서 배운 것처럼, 명명과 한가지 함수는 한가지만 하도록 하는 방향으로 정리하는 것이 좋지 않았을 까 생각한다.

쓸 데 없는 방에 두사람 있다는 등.. 로비 나간다라는 등, 이런 것의 주석은 삭제해도 사실 코드를 읽는데는 전혀 지장이 없어서, 쓸데 없는 중복되는 주석이고, request_join_room 이런것은 join_request_from_client, reject_join_room은 reject_room_full 등으로 바꾸면, 굳이 주석을 쓰지 않아도 되지 않을까 한다.