ASP 개발을 효율적으로 하는 방법 – 변수 네이밍,주석

두번째로 프로그램 내에서 사용되는 네이밍룰과 주석에 관하여 말씀 드리려고 합니다.

1. 변수명

ASP는 JSP나 PHP처럼 변수의 타입을 지정하지 않고 사용하기 때문에 프로그램이 복잡해 지면 변수의 이름이 제 각각으로 되고 무엇에 쓰는 변수인지 역 추적하여 알아내야 합니다.

변수명도 프로그램 파일명과 같이 접두어를 붙여 어떤 형태의 변수인지 알 수 있도록 합니다. 다음의 예는 Microsoft에서 제안한 것을 거의 그대로 가져온 것 입니다.

(URL : http://msdn.microsoft.com/library/en-us/dnasp/html/aspconv.asp?frame=true)

접두어 자료형
bln boolean blnsample
byt byte bytsample
col collection object colsample
cur currency cursample
dtm date-time dtmsample
dbl double dblsample
err error errsample
int integer intsample
lng long lngsample
obj object objsample
sng single sngsample
str string strsample
udt user-defined type udtsample
vnt variant vntsample
cmd ado command cmdsample
cnn ado connection cnnsample
fld ado field fldsample
prm ado parameter prmsample
rst ado recordset rstsample

물론 위의 내용을 절대적으로 따라야 하는 것은 아니고 ASP에서 사용하는 변수의 형태는 한정되어 있으므로 필요하신 대로 골라서 사용하시면 됩니다. 너무 변수의 이름이 길지 않도록 하고 의미가 통하는 경우에 약어를 적절히 사용합니다.

2. 함수명

대문자로 시작하며 동사+명사의 형태로 되도록 합니다.

예) Function CheckLogin(paramReturnUrl)

3. 기타

포함파일이나 인수의 이름에 관련한 규칙의 예 입니다.

접두어 설명
g_ global.asa에서 생성된 변수
m_ 인클루드되는 모듈페이지(asp,inc 등) 안에서 생성된 변수
fnc_ 공용함수내에서 생성된 변수
param 함수의 파라미터 변수 (paramreturnurl)

중요한 것은 일관되게 네이밍룰를 지켜야 한다는 것입니다. 그렇지 않으면 마련한 기준이 의미가 없어지게 됩니다.

다음으로 주석에 관련한 사항입니다. 주석을 너무 많이 사용하는 것 보다 필요한 부분에 조금씩 적절하게 사용하는 것이 중요합니다. 누가 보더라도 알 수 있는 부분에 굳이 설명을 넣을 필요는 없겠지요.

프로그램과 함수의 기능을 간략하게 설명해 주는 주석을 예로 들어 보겠습니다.

1. 프로그램 설명 주석

‘——————————————————
‘ 프로그램명 : frm_prod.asp
‘ 설명 : 가격비교 상품 등록 및 수정 form
‘ 제작자 : 홍길동
‘ 제작일자 : 2003-09-18
‘ 수정일자 : 2003-09-19
‘ 수정자 : 홍길순
‘ 수정내용 : 수정 form기능 추가
‘ 수정일자 : 2003-10-18
‘——————————————————

간략한 설명과 수정내역을 기록하여 프로그램 관리에 많은 도움을 얻을 수 있습니다. 그리고 소스 중간에 몇 일에 누가 수정했다는 주석을 달아 변경된 위치를 정확히 알 수 있도록 합니다.

2. 함수 설명 주석

‘——————————————————–
‘함수명 : checklogin(paramreturnurl)
‘설명 : 로그인 여부 검사
‘인수 : paramreturnurl : 다시 돌아갈 url
‘반환값 : true : 로그인
‘ : false : 로그인 안함
‘작성자 : 홍길동
‘작성일자 : 2003-10-14
‘수정자 :
‘수정일자 :
‘수정내용 :
‘——————————————————–

함수도 프로그램과 비슷하게 상단에 주석을 추가하여 기능과 반환값을 한 눈에 알 수 있도록 합니다. 나중에 함수 설명만 모아서 레퍼런스로 만들 수 있습니다. 함수가 작성되어 있는 포함파일과 함수 설명만 알고 있다면 손쉽게 호출하여 사용할 수 있습니다.

위의 예시는 언제까지나 예시이고 필요한 항목을 추가하여 좀더 좋은 원칙을 만드는 것이 더 도움이 되리라 생각합니다.

개인적인 의견으로 Option Explicit 구문을 이용하여 필요한 변수만 미리 선언하여 사용하는 방법도 좋겠습니다. 제 경험상 Option Explicit 구문을 사용하시려면 개발 초기부터 사용하기로 결정하고 일관되게 지켜 나가는 것이 중요합니다. 개발이 어느 정도 진행된 경우라면 적용하기가 어렵습니다. 기존의 프로그램도 수정해야 하니까요.

이 내용을 참고 삼아 더 좋은 자신만의 가이드라인을 만들어 보시기 바랍니다.

다음에는 프로그램 외적인 부분에 관하여 말씀드리겠습니다.

답글 남기기

이메일은 공개되지 않습니다. 필수 입력창은 * 로 표시되어 있습니다

Time limit is exhausted. Please reload the CAPTCHA.