주석에 대해서(2)

델파이를 써온지도 어언 10년이 되어 갑니다. 델파이2, 5 를 거쳐서 지금은 2007로 작업을 하는 중이지요.

저는 주석을 달때 가능하면 다음의 룰을 지킵니다.

1. 단순 설명(블럭단위가 아닌 경우)에는 표시선에 합니다.

editor를 보면 가운데 상하로 줄이 하나 죽~ 가있지요. 특별히 손대지 않으면 대부분 80컬럼정도에서 그어집니다. (이거 고치려면 Tool - Option - Editor Options - Display에 보면 Margin and gutter에 Right-margin 의 값을 수정해 주면 됩니다.)

대부분의 주석선은 여기에 맞춰서 합니다.

물론, 하다보면 소스가 길어지면서 넘어가는 경우가 생기죠. 그런데.. 이거 소스가 길어지면 화면이 좌우로 스크롤 되는 경우가 생깁니다. 그러면 가독성이 떨어지죠. 그래서 저 같은 경우는 소스가 길어지면 Right margin근처에서 개행을 하는 편입니다. 그리고 그뒤에 주석을 달죠.

물론.. 하다보면 길어질 수도 있습니다. 연속적으로 동일한 소슥가 있다보니 복사 및 수정, 또는 변경내역을 한눈에 확인 하기 위해 일부러 한줄로 쭉~ 붙여쓰기도 합니다.

if ... then begin A1 end else begin A2 end;
if ... then begin B1 end else begin B2 end;
if ... then begin C1 end else begin C2 end;

원래의 제 코딩 스타일대로라면 then, begin, end, else 등 다음에는 반드시 엔터가 들어가서 개행을 해야 합니다만, 그렇게 하면 위아래의 변화(?)를 한번에 파악하기 어려울 수도 있습니다.

if ... then
begin 
    A1
end
else
begin
    A2
end;
...
...

이렇게 되면 줄이 좀.. 길어지죠. 물론 전제조건은 A1,2 B1,2등이 그렇게 길지 않다라는 전제로 갑니다.
2. 블럭단위로 필요한 경우에는 해당소스의 들여쓰기와 같은 들여쓰기로 기재한다.

한무더기(?)로 싸잡아서 주석을 달고 싶을 때가 있죠.  이때 저는 주석의 시작, 끝을 달아서 범위를 표시합니다.

/////////////////////////////////////////////////
// 어쩌구저쩌구 시작.

어쩌구 저쩌구...

// 어쩌구저쩌구 끝.
/////////////////////////////////////////////////

이러면 일종의 주석이 블럭을 형성하죠.

이 블럭단위 주석을 쓰는 경우가 unit상단에 선언부인 경우가 많습니다. 작업을 하다보면 일정작업에 관련되는 함수들이 죽.. 발생할때가 있죠. 예를 들면 화면 조정관련 이라든가.. 시작제어라든가..

물론, 저는 함수를 기록할때 다음의 룰을 따릅니다.

1. procedure와 function끼리 모은다.

2. 펑션을 모을때는 리턴값의 종류에 따라 모은다. 예를 들면 리턴이 string인것 끼리, TAdoQuery인거끼리, Integer인거 끼리.. 등이다.

다만, 함수량이 너무 많아지고, 전문화 되기 시작하면 이 함수들을 위의 조건에 맞춰서 주석으로 나누게 됩니다.

/////////////////////////////////////////////////
// 화면제어 시작.

function 화면제어 함수들 : Return

procedure 화면제어 함수들
// 화면제어 끝.
/////////////////////////////////////////////////
//저장관련 함수 시작

....

//저장관련 함수 끝
/////////////////////////////////////////////////

이런식으로 일일히 나눕니다. 그러면 이동이나 정리에 나름 편하더군요...