제목펄(Perl) 코딩 스타일(Code Layout)
시작하며많은 사람들은 펄(Perl)의 코드에 대해 두려움을 가지고 있습니다. 걱정하지 마세요. 대부분의 경우 이런 오해는 경험해보지 못한 상태의 막연한 걱정인 경우가 대부분입니다. 어떤 언어라도 일관되고 지속적이며, 깔끔한 코딩 스타일을 지키지 않는다면 이해하기 어려우며, 버그를 잡는 것도, 수정을 하는 것도 쉬운 일이 아닙니다. 이 문서는 펄 프로그램을 견고하며 효율적이고, 유지보수가 손쉬운 코드를 작성하는 방법을 소개합니다.
코딩 스타일이란 무엇입니까?동일한 표현
왜 코딩 스타일을 지켜야 하나요?올바른 코딩 스타일은 견고하고, 효율적이며, 유지보수가 손쉬운 코드를 작성할 수 있게 합니다. 아래의 코딩 스타일은 룰이 아니라 가이드라인입니다. 즉 이런 룰을 따르기를 여러분에게 권고하는 것입니다. 만약 동의할 수 없는 부분이 있다면 팀원들과 여러번 숙고하고 논의를 거친다음 프로젝트와 팀원들에게 가장 적당한 코딩 스타일을 선택하면 됩니다. 단 중요한 것은 일관되고, 지속적으로 하나의 코딩 스타일을 유지해야 한다는 점입니다. 소개하는 가이드라인들은 비단 펄 뿐만아니라 다른 프로그래밍시에도 도움이 될 것입니다. 논란의 여지가 있다면, 적어도 펄로 코드를 작성할 때 만큼이라도 가이드라인을 지키려는 노력을 하는 것을 추천합니다. 이 단락의 모든 가이드라인은 CPAN의 굵직굵직한 모듈의 저자인 Damian Conway의 Perl Best Practices(O'REILLY)에서 발췌했습니다.
펄 커뮤니티가 추천하는 가이드라인
괄호로 묶는 방법(Bracketing)중괄호({}, brace)와 소괄호((), parenthesize)는 K&R 스타일을 따릅니다. 코드 블록을 설정할 때는 K&R 형식의 브라켓팅을 사용합니다. 블록을 제어하는 컨스트럭트의 끝에 괄호를 엽니다. 다음 줄에서 한 레벨의 들여쓰기를 한 후 내용을 작성합니다. 블록을 제어하는 컨스트럭트와 동일한 들여쓰기 수준에서 괄호를 닫도록 합니다. 사용 예:
my @names = (
'Kim', # Last name
'Do-hyoung', # First name
'Keedi', # English name
);
for my $name (@names) {
for my $word ( anagrams_of(lc $name) ) {
print "$word\n";
}
}
BSD 스타일과 GNU 스타일로 작성하지 않도록 합니다:
# BSD 스타일
my @names =
(
'Kim', # Last name
'Do-hyoung', # First name
'Keedi', # English name
);
for my $name (@names)
{
for my $word ( anagrams_of(lc $name) )
{
print "$word\n";
}
}
# GNU 스타일
for my $name (@names)
{
for my $word ( anagrams_of(lc $name) )
{
print "$word\n";
}
}
vi 에서는 '%'를 이용해서 현재 커서가 위치하고 있는 괄호에 대응하는 괄호로 이동할 수 있으며, Emacs에서는 이 작업을 수행하기 위해 .emacs 설정 파일에 다음 내용을 추가하도록 합니다:
;; Use % to match various kinds of brackets...
(global-set-key "%" 'match-paren)
(defun match-paren (arg)
"Go to the matching paren if on a paren; otherwise insert %."
(interactive "p")
(cond ((string-match "[[{(<]" next-char) (forward-sexp 1))
((string-match "[\]})>]" prev-char) (backward-sexp 1))
(t (self-insert-command (or arg1)))))
키워드(Keywords)제어 키워드(control keyword)는 따라오는 여는 괄호와 분리합니다. 제어문은 프로그램의 흐름을 변경하기 때문에 빈번하게 사용합니다. 그렇기 때문에 제어 키워드는 소스 코드에서 명확하게 보여야 합니다. 펄에서 대부분의 제어 구조에 사용하는 제어 키워드는 여는 괄호가 따라오는 경우가 많습니다. 이 소괄호는 함수 호출시 사용하는 괄호와 헷갈릴 수 있습니다. 그렇기 때문에 키워드와 여는 괄호 사이 한 칸의 공백 문자를 주어 함수 호출과 제어문을 명확하게 구분하도록 합니다. 다음과 같이 작성하도록 합니다:
for my $result (@results) {
print_sep();
print $result;
}
while ($min < $max) {
my $try = ($max - $min) / 2;
if ($value[$try] < $target) {
$max = $try;
}
else {
$min = $try;
}
}
다음과 같이 작성하지 않도록 합니다:
for(@results) {
print_sep();
print $result;
}
while($min < $max) {
my $try = ($max - $min) / 2;
if($value[$try] < $target) {
$max = $try;
}
else{
$min = $try;
}
}
서브루틴과 변수(Subroutines and Variables)서브루틴 호출과 변수 이름 다음에 여는 괄호가 나올 경우 띄어쓰지 않습니다. 앞서 말한 규칙과 연관이 있는 부분입니다. 서브루틴 호출을 제어 키워드로 착각하거나, 또는 배열의 한 부분임에도 불구하고 독립적인 스칼라 변수로 잘못 읽는 것과 같은 실수를 방지할 수 있습니다. 그러므로 서브루틴 호출시 사용하는 ()와 변수 이름 다음에 나오는 [], {}의 경우 공백없이 붙여서 사용하도록 합니다. 다음과 같이 작성하도록 합니다:
my @candidates = get_candidates($marker);
CANDIDATE:
for my $i (0..$#candidates) {
next CANDIDATE if open_region($i);
$candidates[$i]
= $incumbent{ $candidates[$i]{reigion} };
}
다음과 같이 작성하지 않도록 합니다:
my @candidates = get_candidates ($marker);
CANDIDATE:
for my $i (0..$#candidates) {
next CANDIDATE if open_region ($i);
$candidates [$i]
= $incumbent {$candidates [$i] {region}};
}
빌트인(Builtins)빌트인과 “honorary” 빌트인에 대해서 불필요한 괄호를 넣지 않습니다. perl의 많은 빌트인 함수들은 사실상 키워드입니다. 그렇기 때문에 특별히 우선순위를 강제하고 싶은 경우가 아니라면 괄호 없이 사용하는 것은 문법에 어긋나지 않습니다. 빌트인을 호출할 때 괄호를 제외하면 코드가 난잡해지는 것을 막을 수 있으며, 결국 가독성을 높일 수 있습니다. 또한 함수 호출과 빌트인의 호출을 시각적으로 구분할 수 있습니다. 다음과 같이 작성하도록 합니다:
while (my $record = <$results_file>) {
chomp $record;
my ($name, $votes) = split "\t", $record;
print 'Votes for ',
substr($name, 0, 10), # Parens needed for precedence
": $votes (verified)\n";
}
``honorary(명예로운)'' 빌트인은 확실하게 임포트(import)한 서브루틴, 즉 펄의 코어 배포판에 속해있는 모듈을 의미합니다. 전형적으로 이러한 ``honorary'' 빌트인은 언어에서 제공하는 편이 좋지만 실제로 그렇지 않은 서브루틴을 의미합니다. 이러한 경우도 괄호 없이 호출할 수 있습니다. 여기에 속하는 것의 예로는 표준 Carp 모듈의 carp, croak, 표준 List::Util 모듈의 first, max, CPAN IO::Prompt 모듈의 prompt 등이 있습니다. 만약 빌트인에 대해 괄호를 표기해야할 필요가 있다면 서브루틴의 규칙을 따릅니다. 제어 키워드의 규칙을 따르지 않습니다. 즉 빌트인 이름과 여는 괄호 사이에 공백 문자를 두지 않습니다. 다음과 같이 작성하도록 합니다:
while (my $record = <$result_file>) {
chomp( $record );
my ($name, $votes) = split("\t", $record);
print(
'Votes for ',
substr($name, 0, 10),
": $votes (verified)\n"
);
}
다음과 같이 작성하지 않도록 합니다:
while (my $record = <$result_file>) {
chomp ($record);
my ($name, $votes) = split ("\t", $record);
print(
'Votes for ',
substr ($name, 0, 10),
": $votes (verified)\n"
);
}
키와 인덱스(Keys and Indices)키나 인덱스가 복잡하다면 그것을 둘러싼 괄호와 분리합니다. 리스트의 해쉬의 해쉬와 같이 복잡한 자료 구조의 요소에 접근하는 경우 길고, 복잡하고, 빽빽한 형태가 되기 쉽습니다. 예를 들면 다음과 같습니다:
$candidates[$i] = $incumbent{$candidates[$i]{get_region()}};
공백 없이 빽빽하게 표기하는 경우 읽기도 힘들 뿐만 아니라 괄호가 빠진 경우 알아채기도 쉽지 않습니다. 인덱스가 간단한 상수거나 스칼라 변수가 아닐 경우 괄호 사이에 빈 칸 하나를 인덱스 좌우에 삽입합니다. 다음과 같이 작성하도록 합니다:
$candidates[$i] = $incumbent{ $candidates[$i]{ get_reigion() } };
또한 비록 간단한 상수거나 스칼라 변수라 하더라도 일반적이지 않게 길이가 길다면 역시 괄호 사이에 빈 칸을 삽입하는 것이 낫습니다:
print $incumbent{ $largest_gerrymandered_constituency };
이렇게 작성하지 않습니다:
print $incumbent{$largest_gerrymandered_constituency};
연산자(Operators)이항 연산자의 경우 피연산자와 구분하기 쉽게 공백 문자를 사용합니다. 이렇게 표기하기 보다는:
my $displacement=$initial_velocity*$time+0.5*$acceleration*$time**2;
my $price=$coupon_paid*$exp_rate+(($face_val+$coupon_val)*$exp_rate**2);
줄을 더 사용하더라도 이렇게 표기합니다:
my $displacement
= $initial_velocity * $time + 0.5 * $acceleration * $time**2;
my $price
= $coupon_paid * $exp_rate + ($face_val + $coupon_paid) * $exp_rate**2;
연산자의 우선순위를 고려하여 공백 문자의 개수를 결정합니다. 이경우 읽는 사람은 자연스럽게 그룹화를 할 수 있습니다. 위의 예에서는 상대적으로 우선 순위가 낮은 + 연산자는 좌우 공백 문자를 2개 주었으며, ** 연산자는 빽빽하게 붙임으로서 높은 우선 순위임을 쉽게 이해할 수 있습니다. 괄호를 사용해서 우선 순위를 강조할 때도 한 칸의 여백이면 충분합니다:
my $velocity
= $initial_velocity + ($acceleration * ($time + $delta_time));
my $future_price
= $current_price * exp($rate - $dividend_rate_on_index) * ($delivery - $now);
심볼 단항 연산자(symbolic unary operator)의 경우 피연산자와 붙여서 사용합니다:
my $spring_force = !$hyperextended ? -$spring_constant * $extension : 0;
my $payoff = max(0, -$asset_price_at_maturity + $strike_price);
이름이 있는 단항 연산자의 경우 빌트인과 동일하게 피연산자 앞에 공백 문자를 하나 둡니다:
my $tan_theta = sin $theta / cos $theta;
my $forward_differential_1_year = $delivery_price * exp -$interest_rate;
세미콜론(Semicolons)모든 명령문(statement) 뒤에는 세미콜론을 표기합니다. Perl에서는 명령문을 세미콜론으로 구분합니다. 그러므로 블록의 마지막 명령문은 세미콜론이 없어도 상관없습니다. 하나의 명령문으로 블록이 구성되어도 세미콜론은 없어도 됩니다. 그렇지만 이 두 경우 모두 반드시 세미콜론을 표기합니다. 다음과 같이 작성합니다:
while (my $line = <>) {
chomp $line;
if ( $line =~ s{\A (\s*) -- (.*)}{$1#$2}xms ) {
push @comments, $2;
}
print $line;
}
다음과 같이 작성하지 않도록 합니다:
while (my $line = <>) {
chomp $line;
if ( $line =~ s{\A (\s*) -- (.*)}{$1#$2}xms ) {
push @comments, $2
}
print $line
}
위와 같이 블록의 마지막 문장에 세미콜론을 생략하는 경우 가장 큰 문제는 다음과 같이 새로운 문장을 추가할 때 일어납니다:
while (my $line = <>) {
chomp $line;
if ( $line =~ s{\A (\s*) -- (.*)}{$1#$2}xms ) {
push @comments, $2
/shift/mix
}
print $line
$src_len += length;
}
이것은 발견하기도 쉽지 않을 뿐만 아니라 펄 컴파일러는 변경한 소스 코드를 다음과 같이 해석할 것입니다. 에러가 나지 않는다면 이러한 오류는 발견하기가 더욱 어렵습니다:
while (my $line = <>) {
chomp $line;
if ( $line =~ s{\A (\s*) -- (.*)}{$1#$2}xms ) {
push @comments, $2 / shift() / mix()
}
print $line ($src_len += length);
}
이 규칙은 map과 grep을 사용할 때 {}안에 하나의 명령문으로 구성되는 경우는 제외합니다. 이때는 세미콜론을 사용하지 않습니다. 세미콜론을 사용하면 명령문이 끝나는 위치를 파악하기 어렵습니다. 다음과 같이 사용합니다:
my @sqrt_results
= map { sqrt $_ } @results;
다음과 같이 사용하지 않습니다:
my @sqrt_results
= map { sqrt $_; } @results;
map이나 grep의 {}안에서 과도하게 많은 명령문을 사용하는 경우는 위의 규칙을 적용하지 않습니다. 그렇지만 이렇게 map과 grep안에서 많은 명령문을 사용하는 것은 좋은 선택이 아닙니다. {}안에서 많은 명령문을 사용해야 한다면 그 명령문들을 서브루틴 안에 넣습니다.
쉼표(Commas)여러 줄로 표현하는 리스트는 모든 값들 다음에 쉼표를 넣습니다. 세미콜론이 명령문을 구분한다면 쉼표는 리스트의 값들을 구분합니다. 값을 구분한다는 측면에서 쉼표를 종결자(세미콜론)과 동일하게 다룹니다. 즉 모든 값들 다음에 쉼표를 넣습니다. 다음과 같이 작성합니다:
my @dwarves = (
'Happy',
'Sleepy',
'Dopey',
'Sneezy',
'Grumpy',
'Bashful',
'Doc',
);
이 리스트의 순서를 바꾸는 것은 쉬운 일입니다. 단지 잘라내고 붙이면 그만입니다:
my @dwarves = (
'Bashful',
'Doc',
'Dopey',
'Grumpy',
'Happy',
'Sleepy',
'Sneezy',
);
만약에 원래의 리스트에서 'Doc' 다음에 쉼표를 표기하지 않았다면 순서를 바꾸고 난 다음 코드는 원치 않는 결과를 초래합니다:
my @dwarves = (
'Bashful',
'Doc'
'Dopey',
'Grumpy',
'Happy',
'Sleepy',
'Sneezy',
);
줄 길이(Line Lengths)한 줄을 78칸으로 사용합니다. 고해상도의 모니터와 안티-앨리어스 폰트 등 현대의 장비에서 터미널 윈도우의 한 줄의 길이를 300칸으로 하는 것은 문제가 아닙니다. 제발 그러지말길 바랍니다. 출력 문서, VGA 디스플레이 장치, 프리젠테이션 소프트웨어, 옛날 스타일의 관리자와 같은 한계를 생각하도록 합니다. text-wrapping 캐릭터가 있는 몇몇의 터미널과 에디터기, 그리고 메일 시스템을 생각한다면 80칸도 충분하지 않습니다. vi 에서는 오른쪽 마진을 다음과 같이 설정할 수 있습니다:
set textwidth=78
Emacs 에서는 다음과 같이 설정합니다:
(setq fill-column 78)
(setq auto-fill-mode t)
78칸을 사용할 때의 또 다른 장점은 이 메일을 통해 보낼 때 적어도 한번은 래핑(wrapping)되는 것을 막을 수 있다는 것입니다. (이메일 답장을 보낼 때 문자열 앞에 '> '가 붙는 것을 의미합니다.)
들여쓰기(Indentation)4칸의 들여쓰기를 사용합니다. 들여쓰기의 깊이는 줄 길이보다 더 많은 논쟁을 불러일으킵니다. 네 명의 프로그래머에게 적합한 들여쓰기의 깊이에 대해서 묻는다면 아마도 네 가지 다른 답을 얻을 수 있을 것입니다. 2칸?, 3칸?, 4칸, 또는 8칸... 그리고 여러분 역시 그 논쟁을 격렬하게 만들 것입니다. 깊은 들여쓰기는 구조적으로 가독성을 높이나 문맥적 가독성은 떨어집니다. 얕은 깊이의 들여쓰기는 위와 반대입니다. 어쨌든 Perl을 사용한다면 4칸의 들여쓰기를 사용하도록 합니다. 물론 들여쓰기 레벨이 4단계 이상으로 들어간다면 함수나 모듈로 분리를 해야할 것입니다. 코드는 다음과 같이 작성합니다:
while (my $line = <>) {
chomp $line;
if ( $line =~ s{\A (\s*) -- (.*)}{$1#$2}xms ) {
push @comments, $2;
}
print $line;
}
다음과 같이 작성하지 않습니다:
# 들여쓰기 깊이: 8
while (my $line = <>) {
chomp $line;
if ( $line =~ s{\A (\s*) -- (.*)}{$1#$2}xms ) {
push @comments, $2;
}
print $line;
}
# 들여쓰기 깊이: 2
while (my $line = <>) {
chomp $line;
if ( $line =~ s{\A (\s*) -- (.*)}{$1#$2}xms ) {
push @comments, $2;
}
print $line;
}
탭(Tabs)탭이 아닌 스페이스로 들여쓰기를 합니다. 에디터기에서 탭스페이스를 4칸으로 설정할 수 있다 할지라도 탭 문자를 사용하는 것은 나쁜 선택입니다. 프린팅을 하거나 다른 출력 장치에서, 또는 워드 프로세서 문서로 붙여넣거나 다른 탭스페이스의 에디터에서 볼 때 동일하게 보이지 않습니다. 그러므로 탭을 쓰거나, 탭과 스페이스를 혼용해서 사용하지 않습니다. 들여쓰기는 스페이스로만 구성하며, 앞서 나온 들여쓰기 깊이와 관련한 룰을 지키도록 합니다:
sub addarray_interval {
my ($var_name, $need_quotemeta) = @_;
$raw .= $var_name;
my $quotemeta = $need_quotemeta ? q{ map {quotemeta $_} }
: $EMPTY_STR
;
my $perl5pat
= qq{(??{join q{|}, $quotemeta \@{$var_name}})};
push @perl5pats, $perl5pat;
return;
}
들여쓰기 깊이를 4칸으로 하고 공백 문자만 사용해야 한다고 탭키를 사용하지 못하는 것은 아닙니다. 많은 현대적인 에디터들은 탭 문자를 공백 문자로 확장하는 기능을 제공합니다. vi의 경우:
set tabstop=4 "An indentation level every four columns"
set expandtab "Convert all tabs typed into spaces"
set shiftwidth=4 "Indent/outdent by four columns"
set shiftround "Always indent/outdent to the nearest tabstop"
Emacs의 경우(using ``cperl'' mode):
(defalias 'perl-mode 'cperl-mode)
;; 4 space indents in cperl mode
'(cperl-close-paren-offset -4)
'(cperl-continued-statement-offset 4)
'(cperl-indent-level 4)
'(cperl-indent-parens-as-block t)
'(cperl-tab-always-indent t)
블록(Blocks)절대로 같은 줄에 두 개의 명령문을 작성하지 않습니다. 다음과 작성하지 않습니다:
RECORD:
while (my $record = <$inventory_file>) {
chomp $record; next RECORD if $record eq $EMTPY_STR;
my @fields = split $FIELD_SEPARATOR, $record; update_sales(\@fields);$count++;
}
다음과 같이 작성합니다:
RECORD:
while (my $record = <$inventory_file>) {
chomp $record;
next RECORD if $result eq $EMTPY_STR;
my @fields = split $FIELD_SEPARATOR, $record;
update_sales(\@fields);
$count++;
}
이 규칙은 명령문이 하나를 넘어가는 map과 grep 블록에도 적용하도록 합니다:
my @clean_words
= map {
my $word = $_;
$word =~ s/$EXPLETIVE/[DELETED]/gxms;
$word;
} @raw_words;
다음과 같이 작성하지 않도록 합니다:
my @clean_words
= map { my $word = $_; $word =~ s/$EXPLETIVE/[DELETED]/gxms; $word; } @raw_words;
청크, 덩어리(Chunking)코드는 단락(paragraph) 형태로 작성합니다. 단락(paragraph)은 단일한 작업을 수행하는 명령문의 집합입니다. 문학에서 단락은 하나의 생각을 나타내는 문장들의 집합입니다. 프로그래밍에서 단락은 알고리즘의 한 단계(single step)의 구현을 위한 명령어의 집합입니다. 코드의 각 조각을 한 단계를 수행하는 시퀀스대로 나누고, 각각의 시퀀스 사이는 하나의 빈 줄을 삽입합니다. 코드의 유지보수를 쉽게 하기위해 각각의 단락의 시작 앞에는 명령문들의 시퀀스가 무엇을 하는지에 대한 1줄 짜리 주석을 달도록 합니다. 다음과 같이 작성하도록 합니다:
# Process an array that has been recognized...
sub addarray_internal {
my ($var_name, $needs_quotemeta) = @_;
# Cache the original...
$raw .= $var_name;
# Build meta-quoting code, if requested...
my $quotemeta = $needs_quotemeta ? q{map {quotemeta $_} } : $EMPTY_STR;
# Expand elements of variable, conjoin with ORs...
my $perl5pat = qq{(??{join q{|}, $quotemeta \@{$var_name}})};
# Insert debugging code if requested...
my $type = $quotemeta ? 'literal' : 'pattern';
debug_now("Adding $var_name (as $type)");
add_debug_mesg("Trying $var_name (as $type)");
return $perl5pat;
}
사람이 순간적으로 집중해서 기억할 수 있는 공간이 크지 않기 때문에 단락 별로 나누어 코딩을 하면 읽기가 쉬워지며 각각의 단락에 집중할 수 있습니다. 또한 단락은 논리적인 구조를 물리적인 구조로 반영하며 또한 강조합니다. 각 단락의 시작에 주석을 달아 명시적으로 각각의 덩어리(chunk)의 목적에 대해 요약함으로써 덩어리 별로 나누는 것을 강화할 수 있습니다. 주석은 각각의 덩어리의 동작(actions)에 대해 언급하는 것이 아니라 목적(purpose), 왜 이 코드가 필요한가? 에 대해서 언급하는 것입니다. 그렇지만 단락의 내용은 두 번째로 중요합니다. 단락 별로 수직적인 갭(빈 줄)이 정말 중요하다는 말입니다. 이것 없이는 주석을 계속 유지한다고 하더라도 코드의 가독성은 현격하게 떨어집니다:
# Process an array that has been recognized...
sub addarray_internal {
my ($var_name, $needs_quotemeta) = @_;
# Cache the original...
$raw .= $var_name;
# Build meta-quoting code, if requested...
my $quotemeta = $needs_quotemeta ? q{map {quotemeta $_} } : $EMPTY_STR;
# Expand elements of variable, conjoin with ORs...
my $perl5pat = qq{(??{join q{|}, $quotemeta \@{$var_name}})};
# Insert debugging code if requested...
my $type = $quotemeta ? 'literal' : 'pattern';
debug_now("Adding $var_name (as $type)");
add_debug_mesg("Trying $var_name (as $type)");
return $perl5pat;
}
|
언어 펄
윈도우 펄
CGI
데이터베이스
mod_perl&Mason
ⓟerlmania 1999 - 2009