프로그램의 파일명에 관한 것을 말씀드리겠습니다.
작업을 하다 보면 새로운 파일을 추가하면서 이름을 입력하게 되는데 즉흥적으로 떠오르는 영문단어를 이용하여 짓게 됩니다. 파일의 수가 적고 프로그램 목록이 정리되어 있다면 문제 될 것이 없지만 점점 개수가 늘어나게 되면 어떤 기능을 하는지 모두 열어서 확인해야 하는 문제가 발생하게 됩니다.
일단 각 폴더에 존재하는 프로그램 파일의 이름과 기능을 정리한 프로그램 목록을 정리합니다. 너무 복잡하게 만들면 이것 자체가 또 하나의 일이 될 수 있으므로 간략하게 정리합니다. 간단하게 프로그램 파일명, 기능, 폴더위치 정도로 정리하시면 됩니다. 별도로 필요한 정보를 추가하시면 더욱 좋겠지요.
프로그램이 추가 되면 귀찮지만 같이 수정해 놓으면 나중에 많은 시간을 절약할 수 있습니다.
다음으로 프로그램 파일에 접두어를 붙여 이름만 보고 대강 어떤 기능을 하는 프로그램인지 알 수 있도록 합니다. 예를 들어보겠습니다.
접두어
|
내용
|
viw_ | 상세 정보를 보이는 페이지 |
lst_ | 정보의 목록을 보이는 페이지 |
frm_ | 정보를 등록하기 위해 보이는 페이지(form) |
upd_ | 정보를 수정하기 위해 보이는 페이지 |
del_ | 정보를 삭제하기 위해 보이는 페이지 |
prs_ | 정보를 처리(입력/수정/삭제)하는 페이지 |
없음 | 기타 사용자 정의된 페이지명(index, sitemap 등) 가능 |
다음은 포함(include) 파일에 관한 접두어 예 입니다.
접두어
|
내용
|
menu_ | 메뉴를 표시하는 페이지 (뒤에 left, right, top, bottom 등을 추가로 붙여 어느 위치에 있는 메뉴인지 나타내면 더 좋겠네요) |
db_ | database 관련 함수나 기능 |
fnc_ | 공통함수 모음 |
없음 | 기타 사용자 정의된 페이지명 가능 |
이런 방법으로 접두어를 지정하여 수정을 위해 프로그램을 열 때 시간을 절약할 수 있습니다. 제가 예로 든 방법이 절대적인 것은 아닙니다. 각자의 노하우와 작업 환경, 실정에 맞게 가장 알맞은 방법으로 정리하여 그것을 준수하여 작업하는 것이 좋은 방법이라고 생각합니다.
다음에는 변수 네이밍 룰과 주석에 관하여 말씀 드리겠습니다.