설계를 코드로 옮기다

생각 열기 — 설계는 있는데 어디부터

4차시에서 summarize의 알고리즘 27줄을 다 적었다. 이제 코드로 옮기면 된다. 그런데 편집기를 열고 나면 또 막힌다.

첫 줄부터 그대로 옮겨 쓰면 되나? 다른 부품은 아직 없는데 이것만 실행해 볼 수 있나? 다 쓰고 나서 실행했는데 안 되면 어디를 봐야 하지?

뼈대부터 세우고 하나씩 채운다

설계서의 부품 목록을 그대로 빈 껍데기로 먼저 만든다. 하는 일은 없고 이름과 받는 것·돌려주는 것만 있는 상태다.

이렇게 하면 이른 시점에 프로그램 전체가 한 번 돌아간다. 결과는 엉터리지만 부품들이 서로 잘 이어졌는지는 확인된다. 그다음 껍데기를 하나씩 진짜 코드로 바꾼다.

③에서 is_valid부터 만드는 것이 요령이다. 이 부품은 남을 부르지 않으므로 혼자서도 완성할 수 있고, 완성해 두면 summarize를 만들 때 그 부분을 의심하지 않아도 된다. 잘못의 위치를 좁히는 일이 여기서도 그대로 적용된다.

코딩 규칙을 먼저 정한다

여럿이 나눠 만들면 코드 모양이 제각각이 된다. 합칠 때 읽기 어려워지므로 몇 가지를 미리 정해 둔다.

• 규칙 1

  이름 짓는 방식

  뜻이 담긴 이름을 쓴다. 부품 이름은 설계서에 적은 것을 그대로 쓴다 — 문서와 코드가 어긋나지 않게.

• 규칙 2

  들여쓰기

  한 가지로 통일한다. 공백 4칸을 기본으로 한다. 섞이면 Python 에서는 아예 실행되지 않는다.

• 규칙 3

  주석에 적을 것

  무엇을 하는지가 아니라 왜 그렇게 했는지를 적는다. 설계에서 판단한 이유가 여기 온다.

• 규칙 4

  한 부품 한 곳

  한 사람이 한 부품을 맡는다. 같은 부품을 둘이 고치면 6차시에서 충돌이 난다.

알고리즘을 두 언어로 옮겨 보기

4차시의 알고리즘 하나가 언어에 따라 어떻게 갈라지는지 보자. 먼저 평균을 내는 부분만 떼어 낸다. 알고리즘의 23~26줄 — 인원이 0이면 빠져나가고, 아니면 나눈다.

def average(scores):
    if len(scores) == 0:
        return None
    return sum(scores) / len(scores)

scores = [88, 92, 75, 100, 64]
print("평균:", average(scores))
print("빈 목록:", average([]))

평균: 83.8
빈 목록: None

#include <stdio.h>

/* 점수가 없으면 평균을 낼 수 없다. 성공 여부를 반환값으로 알린다. */
int average(const int scores[], int n, double *out)
{
    if (n == 0) return 0;
    int sum = 0;
    for (int i = 0; i < n; i++) sum += scores[i];
    *out = (double)sum / n;
    return 1;
}

int main(void)
{
    int scores[] = {88, 92, 75, 100, 64};
    double avg;

    if (average(scores, 5, &avg))
        printf("평균: %.1f\n", avg);
    if (!average(scores, 0, &avg))
        printf("빈 목록: 평균을 낼 수 없다\n");
    return 0;
}

평균: 83.8
빈 목록: 평균을 낼 수 없다

같은 알고리즘, 다른 표기

구현 중 설계와 달라진 것을 기록한다

코드를 쓰다 보면 설계가 틀렸거나 부족했다는 것을 알게 된다. 위의 C 반환값 문제가 그렇다. 설계서에는 “쓸 수 있는 값이 없으면 없음을 돌려준다”고만 적었는데, C에는 “없음”이라는 값이 없었다.

이때 코드만 고치고 문서를 그대로 두면 문서를 아무도 믿지 않게 된다. 그래서 짧게라도 남긴다.

직접 옮겨 보기

평균: 83.8
빈 목록: None

활동

더 알아보기