노마드코더 | 클린코드 챌린지 (09 / 21)

/// <summary>
/// Nomad Coder - 클린코드 챌린지 - 09 / 21
/// @author         : CloudD
/// @last update  : 2025. 05. 31.
/// @update
///     - 2025. 05. 31 : 최초 작성. (5장. 형식 맞추기)
/// </summary>

Chat GPT 가 생성한 '개발자의 독서' 이미지 #5

오늘은 5장 "형식 맞추기" 를 읽었습니다.

작가의 설명을 따라 여러 가지 규칙들을 살펴보았습니다.

그중에는 제가 이미 사용하고 있는 규칙들도 있었고, 미처 신경 쓰지 못했던 규칙들도 있었습니다.

그 중 인상 깊었던 내용들을 정리해 보았습니다.

신문 기사와 비슷하게 작성하라.

가장 인상 깊었던 부분은 아래의 설명이었습니다.
작가는 이렇게 말합니다.

소스 파일도 신문 기사와 비슷하게 작성하라. 

이름은 간단하면서도 설명이 가능하게 짓는다. 

소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 

아래로 내려갈수록 의도를 세세하게 묘사한다. 

마지막에는 가장 저차원 함수와 세부 내역을 작성한다. 

파일 하나 하나를 이런 규칙에 맞춰서 작성하되, 
각 파일은 200 줄 안팎의 작은 파일로 구성한다면,

전체 프로젝트를 훨씬 이해하기 쉬울 것 같다는 생각이 들었습니다.

종속 함수

또 하나 기억에 남는 부분은 “신문 기사와 비슷하게 작성하라” 는 조언과 닮아 있었습니다.
작가는 코드의 배치 방식에 대해 이렇게 설명합니다

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

작가의 조언대로 코드를 배치한다면, 위에서 아래로 물 흐르듯 코드를 읽을 수 있을 것 같습니다.

소감

두 파트 모두 코드를 고차원에서 저차원으로 배치하여

물 흐르듯 자연스럽게 코드가 읽히게 만들라고 조언합니다.

누군가 제 코드를 읽게 될 상황을 생각하며, 

시간을 들여 더 읽기 쉽게 정리할 필요가 있다는 점을 다시 한번 느꼈습니다.