네이밍 정의
변수, 파일, 디렉토리, 컬럼, 태그의 ID/NAME, 함수 등의 네이밍을 미리 정해서 일관성있게 개발할 수 있도록 하자. 사용용도에 맞게 대/소문자를 구별하도록 한다. 예를들어 변수, 파일, 디렉토리, 태그는 소/대문자이고 데이터베이스의 명칭(컬럼, 테이블)들은 대문자로 표현한다.
사용 용도 | 국 문 | 영 문 |
전체 | 게시판 | board, Board, BOARD |
파일, 변수 | 게시판 목록 | boardList |
파일, 변수 | 게시판 보기 | boardRead, boardView |
파일, ID, NAME | 게시판 등록 폼 | boardWriteForm |
파일, ID, NAME | 게시판 수정 폼 | boardModifyForm |
ID, NAME | 게시판 검색 폼 | boardSearchForm |
변수, ID, NAME, 컬럼 | 제목 | subject, SUBJECT, title |
변수, ID, NAME, 컬럼 | 내용 | contents, CONTENTS |
변수, ID, NAME, 컬럼 | 조회수 | hit, HIT |
변수, ID, NAME, 컬럼 | 작성자 | writer, WRITER |
변수, ID, NAME, 컬럼 | 등록일시 | regDate, REG_DATE |
변수, ID, NAME, 컬럼 | 수정일시 | modDate, MOD_DATE |
변수, ID, NAME, 컬럼 | 아이피 | ip, IP |
변수, ID, NAME, 컬럼 | 번호 | num, NUM |
함수 | 체크 | check |
변수, ID, NAME | 페이지 번호 | page |
변수, ID, NAME | 검색항목 | searchType |
변수, ID, NAME | 검색어 | searchWord |
함수 | 삭제 | remove, delete |
함수 | 수정 | modify, update |
함수 | 등록 | write, insert |
변수 | 수 | count |
변수, ID, NAME | 모드 | mode |
변수 | 이전 | prev |
변수 | 다음 | next |
디렉토리 | 스크립트 | script, js |
디렉토리 | 스타일시트 | css |
파일, 변수, ID, NAME | 처리 | process |
변수, 함수 | 크기 | size, length |
변수, ID, NAME | 결과 | result |
변수 | 총 | total |
. | . | . |
데이터베이스 설계
논리(Logical) 모델링, 물리(Physical) 모델링을 해보자. 단순 하나의 테이블로 존재하기때문에 관계를 맺는 건 없다. 여기서 번호는 PK (Primary Key), 즉 기본키 이다. 기본키는 게시판 테이블의 중복될 수 없는 유일한 값이다.
각 컬럼들의 데이터타입과 NULL 허용여부가 구체화 되는 물리모델링 모습이다.
네이밍, 용어에 대한 문서를 작성하여 공유한다면 개발시 팀원간에 용어의 혼동을 방지할 수 있는 것 같다. 이렇게 작성, 생성된 자원(파일, 소스 등)들은 쉽게 이해할 수 있어 가독성을 향상 시킬 것이다.