오늘은 코딩가이드 작성에 대하여 말씀 드리겠습니다.
개발 프로젝트는 코딩이 필요한 부분이 매우 많지요.
HTML , CSS , JSP , Java , C++ , SQL , Procedure , XML 등일 것입니다. 이 중에서도 JSP와 Java프로그램은 여러명이서 나누어 개발하게 되는데 , 개발자간의 코딩 스타일에 다소의 차이가 있고 개발자 자신의 스타일도 조금씩 바뀌기 때문에 유사한 형태의 코드를 만들어 내기란 여간 어려운 것이 아닙니다.
그래서 제품개발이나 서비스 개발을 진행함에 있어서 일정한 기간마다 개발자들이 모여서 그 동안 작성된 코드의 리뷰를 하는 경우도 자주 봅니다. 물론 코드리뷰의 주목적이 개발자들간의 코딩 스타일을 맞추려는 것이 아니기 때문에 그 부분에 대하여 시간을 많이 할애하지는 않습니다만 누군가 리뷰를 하게 되는 진행이라면 개발자들이 "코딩 가이드"를 한 번이라도 더 보게 될 것입니다.
사족이지만 프로젝트 관리하시는 분들은 개발자들에게 일주에 1-2시간 정도라도 코드리뷰를 할 수 있는 시간을 꼭 주시기 바랍니다. 코드리뷰를 하는 과정이 개발자들 간에 맡은 업무에 대한 비지니스 로직과 개발 테크닉등의 정보교환에 사용되는 중요한 시간이 되기 때문입니다.
코딩가이드는 코드가 필요한 모든 부문에 다 만들어 두는 것이 좋습니다. HTML 같은 경우도 별도 코딩가이드를 정해 두어야 합니다. 화면상의 특정 콘트롤의 이름이 데이터베이스의 필드명과 일치시키는 것이 디버깅 과정에서 얼마나 많은 시간을 아껴주는지 모릅니다.
여기서 주의 하셔야 할 점은 이렇게 문서로 코딩가이드를 만들어 두기만 하면 제대로 지켜지기 어렵습니다. 코딩가이드를 제대로 적용시키려면 반드시 그 가이드를 100% 적용한 샘플 프로그램을 준비하셔야 됩니다. 이 샘플 프로그램을 탬플릿으로 활용하기 때문에 프로젝트 최초의 프로그램이 될 가능성이 높습니다.
첨부의 문서는 코딩가이드의 예입니다. ( 2004년도 자료일 겁니다. )
그리고 하나는 JSP 프로그램입니다. ( 다른 가이드가 적용된 것입니다. )
Coding_Guide_C++_2.txt
index_2.jsp
댓글 없음:
댓글 쓰기