본문 바로가기

더 괜찮은 개발자가 되기위한/시스템 개발하기

개발 표준 정하기

□ 개발 표준 정하기


○ 개발 표준 구성


프로젝트 설계의 개념


개발 표준은 모든 개발자가 동일한 형태의 소스코드를 만들기 위해 필요하다. 소스코드가 동일한 형태로 만들어지면 다른 사람이 개발한 소스를 쉽게 이해할 수 있어 프로그램을 쉽게 수정할 수 있다. 개발 표준은 프로그램 개발 생산성 향상뿐 아니라 프로그램 유지보수를 쉽게 하는 역할을 한다.


일반적으로 개발 표준은 디렉토리 구조와 서버 및 클라이언트 개발표준으로 나뉜다. 디렉토리 구조는 서버에 프로그램을 어떤 구조로 저장할 지에 대한 규칙을 정하는 것이다. 서버 개발 표준은 서버에서 동작하는 자바, php와 같은 프로그램에 대한 프로그램 구조를 정의하는 것이다. 클라이언트 개발 표준은 사용자 화면을 구성하는 HTML CSS, 자바스크립트에 대한 프로그램 구조를 정의한다.

 

UI 디렉토리 구조


UI 디렉토리 구조


UI 디렉토리 구조를 간단히 살펴보자. 디렉토리는 3 레벨로 구성된다. 1레벨은 웹의 루트 디렉토리를 지정한다. 서버 구성에 따라 http://URL/smartbusi/index.html과 같이 호출될 수도 있고 http://URL/index.html과 같이 호출될 수도 있다. 2레벨은 프로그램 종류별로 저장되는 디렉토리를 지정한다. 사용자 화면을 구성하는 jsp HTML ui 디렉토리 아래에 저장되고 이미지는 images 디렉토리 아래에 저장된다. 자바스크립트 파일은 scripts 디렉토리 아래에 저장되며 화면에서 출력하는 리포트 파일은 reports 디렉토리 아래 저장된다. 증빙자료와 같은 파일이 서버로 업로드 된다면 upload 디렉토리 아래에 저장된다. 3레벨은 업무명으로 구분되는데 ui 디렉토리 아래에 영업일지작성, 영업지용관리 등 각각 업무별로 별도의 디렉토리가 생성되어 저장된다. 자바 기반의 프로젝트에서는 UI와는 별개로 비즈니스 로직이 smartbusi/WEB-INF 디렉토리 아래에 따로 저장되는데 선택한 프레임워크에 따라 디렉토리 구성이 달라지게 된다. 채택한 기술 구조에 알맞은 디렉토리 구조를 사전에 정의하는 것이 좋다.

 

UI 코딩 표준


UI 코딩 표준


클라이언트 프로그램의 코딩 표준을 정의하는 UI 코딩 표준은 일반적으로 명명규칙, 주석규칙, 소스코드 구조로 구성된다. 명명규칙은 변수나 함수 이름을 지을 때 사용할 규칙을 정의하는 것이다. 주석규칙은 프로그램 맨 위에 프로그램을 간단하게 설명하는 주석을 어떤 형태로 만들지를 정의하는 것이다. 소스코드 구조는 프로그램의 가독성을 높이기 위해 메타태그, 외부파일 링크, 자체 스크립트 그리고 HTML 파일을 어떤 구조로 구성하지 정의하는 것이다.

 

○ 객체 명명 규칙


HTML 객체 명명 규칙


HTML에서 사용하는 컴포넌트에 대한 명명 규칙을 알아보자. 버튼을 표시하는 Button 컴포넌트 btn이라는 접두어로 시작해야 한다. 조회 기능을 담당한다면 접두어와 업무를 결합해 btnSearch라고 이름을 짖는다. 저장 기능을 수행하는 버튼은 btnSave라 이름을 지으면 된다. 이와 같이 동일한 패턴으로 컴포넌트 이름을 지으면 다른 사람이 프로그램을 분석할 때 코드를 자세히 분석하지 않아도 이름만으로 대략적인 기능을 유추할 수 있다.


○ 메소드 명명규칙


메소드 명명규칙


자주 사용하는 메소스 명명규칙을 살펴보자. 컴포넌트 명명 규칙과 마찬가지고 메소드 명명규칙 또한 프로그램 가독성 및 개발 생산성을 향상시키기 위해 사용한다. 메소드의 동작을 기준으로 이름을 만들면 소스코드 분석 없이 기능을 쉽게 유추할 수 있다.

 

○ 주석 규칙 및 코딩 표준 정하기


주석 규칙 정하기


주석은 소스코드 안에 적어놓은 프로그램에 대한 설명이다. 주석 규칙을 따로 정하기 보다는 주석에 대한 사례를 정확하게 제시하는 것이 보다 효율적이다. 주석에 들어가는 내용은 이 프로그램의 역할이 무엇이고 누가 처음 개발했으며 나중에 언제 누가 왜 수정했는지 정도이다.

코딩 표준 정하기


간단한 HTML 파일을 중심으로 코딩 표준에 대해 알아보자. 인터넷에서 코딩 표준에 대한 많은 자료를 쉽게 찾을 수 있다. 많은 자료들이 변수 이름 뒤에 몇 칸 띄우고 if문 다음에는 뭐가 오고 이런 식으로 자세하게 규칙을 정의하고 있다. 하지만 개발자가 이런 문서를 일일이 읽어보고 코딩을 하기가 쉽지 않다. 우선 개발자는 문서와 별로 친하지 않다. 개발자는 코드를 좋아하면 코드를 보고 이해하기를 원한다.

코딩 표준은 코드로 정의해서 주는 것이 좋다. 간단한 구조의 코드를 사례로 기본적인 구조를 어떻게 가져가야 하는지 설명하는 것이 개발자도 이해하기 좋고 프로그램에 복사해서 넣기도 좋다.