읽기 쉬운 코드 작성 — 들여쓰기·공백·주석 | 기초 C언어 2.1.4
기초 C언어Chapter 02 C언어의 기초 › Section 01 코드 작성
2.1.4 읽기 쉬운 코드 작성
컴파일러는 문법만 맞으면 상관하지 않음. 하지만 코드를 읽는 또 한 사람이 있음. 몇 달 뒤의 나 자신도 남이나 마찬가지.
01코드의 두 독자교재 30p
- 첫 번째 독자 · 컴파일러 — 코드를 기계어로 번역해 실행하는 프로그램. 문법만 정확하면 코드가 얼마나 복잡하게 쓰여 있든 상관하지 않음.
- 두 번째 독자 · 사람 — 그 코드를 읽고 이해해야 하는 쪽. 나 자신, 함께 작업하는 동료, 코드를 평가하는 선생님.
- 몇 달 뒤의 나도 남 — 정리가 안 되어 있으면 내가 쓴 코드도 처음 보는 코드처럼 느껴짐.
02무엇이 좋은 코드인가교재 30p
- 잘 정돈되어 읽기 쉬운 코드 — 이해하기 쉬워서 오류를 찾거나 기능을 추가하기가 훨씬 수월함.
- 읽기 어려운 코드 — 아무리 완벽하게 동작해도 다른 사람이 이해하기 어렵다면 좋은 코드라고 할 수 없음.
- 헷갈리지 말 것 — 읽기 어려운 쪽도 실행은 됨. 컴파일러는 아무 불평도 하지 않음. 다만 사람이 읽기 어려울 뿐.
- 왜 중요한가 — 프로그램을 한 번 만들고 끝내는 일은 거의 없음. 고치고 덧붙이는 일이 계속 이어짐.
03읽기 쉽게 만드는 세 가지교재 30p
가독성 — 사람이 코드를 얼마나 쉽게 읽고 이해할 수 있는지.
1들여쓰기
- 구조가 보이게 하는 방법.
- 중괄호로 묶인 코드 블록에 씀.
2공백과 빈 줄
- 덩어리가 나뉘게 하는 방법.
- 공백은 연산자 좌우에, 빈 줄은 코드 덩어리 사이에.
3주석
- 말로 설명하는 방법.
- 코드 옆이나 위에 적음.
04기본 규칙 ① 들여쓰기교재 30p~31p
코드의 논리적인 구조를 눈에 보이게 해 주는 가장 중요한 방법.
CODE 2.2 | 들여쓰기 없음 (가독성 나쁨)
#include <stdio.h>int main(void){printf("Hello, World!\n");return 0;}
CODE 2.3 | 들여쓰기 있음 (가독성 좋음)
#include <stdio.h>int main(void) {printf("Hello, World!\n");return 0;}
- 왼쪽의 문제 — 다섯 줄이 모두 왼쪽 끝에 붙어 있고, 03줄은 여는 중괄호와 printf가 한 줄에 뭉쳐 있어 몸통이 어디서 시작되는지 보이지 않음.
- 오른쪽의 차이
- 여는 중괄호를 함수의 머리 줄 끝에 붙여 몸통의 시작이 또렷함
- printf와 return은 오른쪽으로 밀려 있고, 닫는 중괄호는 다시 왼쪽 끝으로
- 두 코드의 관계 — 컴파일러에게는 완전히 동일. 사람에게는 가독성에서 큰 차이.
- 규칙 — 중괄호 안의 코드를 바깥 코드보다 오른쪽으로 살짝 밀어서 씀.
05밀어 쓰면 무엇이 보이는가교재 31p
- 한눈에 보인다는 것 — 글자를 하나하나 읽지 않아도 어디까지가 main 함수 안인지 모양만으로 드러남.
- 앞 절과의 연결 — 중괄호는 함수의 몸통. 그 몸통 안에 무엇이 들어 있는지를 들여쓰기가 눈으로 보여 줌.
- 들여쓰기 하는 법 — 스페이스 바 네 번 또는 탭 키 한 번. 어느 쪽을 써도 되지만 한 파일 안에서는 하나로 통일.
06기본 규칙 ② 공백과 빈 줄교재 31p
- 컴파일러는 무시 — 코드의 의미에 영향을 주지 않는 여분의 공백이나 빈 줄을 대부분 무시함.
- 사람에게는 다름 — 이런 공백과 빈 줄이 코드를 훨씬 읽기 편하게 만들어 줌.
- 공백 — 연산자 좌우에 넣으면 수식이 한결 보기 편해짐.
- 연산자란 + - 같은 계산 기호나, 값을 넣을 때 쓰는 =처럼 무언가를 시키는 기호
- 빈 줄 — 서로 다른 역할을 하는 코드 덩어리 사이에 넣으면, 글에서 문단을 나누는 것처럼 코드를 논리적으로 구분할 수 있음.
- CODE 2.1의 02줄이 그런 빈 줄 — 준비하는 줄과 실행이 시작되는 줄을 나눠 놓은 것
07주석의 사용교재 32p
- 주석(Comment) — 소스 코드 안에 작성하지만 컴파일러가 번역하지 않고 완전히 무시하는 부분.
- 왜 적는가 — 컴퓨터가 무시하는 글을 적는 이유는, 주석이 컴파일러가 아니라 사람에게 쓰는 글이기 때문. 앞의 ‘두 독자’로 돌아감.
| 종류 | 표시 | 범위와 쓰임 |
|---|---|---|
| 한 줄 주석 | // | 찍은 자리부터 그 줄 끝까지. 코드 한 줄에 간단한 설명을 붙일 때. 줄이 끝나면 저절로 끝남 |
| 여러 줄 주석 | /* */ | /*부터 */까지 영역 전체. 긴 설명이나 여러 줄을 한 번에 주석 처리할 때. 끝나는 표시를 직접 찍어야 함 |
슬래시와 역슬래시는 다른 기호
- 주석의 // — 오른쪽 위로 누운 빗금(슬래시).
- 줄바꿈의 \n — 반대쪽으로 누운 빗금(역슬래시).
- 방향이 서로 반대이고 하는 일도 전혀 다름.
이 절의 핵심 정리
- 코드의 독자는 둘 — 컴파일러와 사람. 문법만 맞다고 좋은 코드는 아니다
- 들여쓰기 — 중괄호 안의 내용을 바깥보다 한 단계 밀어 쓴다 (스페이스 4번 또는 탭 1번)
- 공백은 연산자 좌우에, 빈 줄은 코드 덩어리 사이에 넣는다
- 주석은 컴파일러가 무시하는, 사람을 위한 메모다
- 한 줄은 //, 여러 줄은 /* */ — 둘의 차이는 끝나는 방식이다
강의 자료2.1.4 읽기 쉬운 코드 작성
1 / 10
번호를 누르면 해당 장으로 바로 이동합니다 · 방향키 ← → 로도 넘길 수 있습니다
다음 절 · 2.2 화면 출력과 printf() 교재 33p~36p — 화면에 글자를 내보내는 명령어와 줄을 바꾸는 방법을 살펴봅니다.
더 자세한 내용은 교재에서
이 글은 『기초 C언어』 30p~32p의 내용을 강의 영상에 맞춰 핵심만 간추린 요약입니다. 각 개념의 상세한 설명과 예제, 실습 코드, 임용시험 기출문제 풀이는 교재에서 다루고 있습니다.
댓글
댓글 쓰기