명명규칙 - winrecruitsystem

Download Report

Transcript 명명규칙 - winrecruitsystem

II. 명명 규칙
1 코딩규칙
2 명명규칙
2.1 코딩규칙
 들여쓰기 규칙
– Tab 간격 : 4 Space
– 단, SQL 작성시 다음 그림과 같이 들여쓰기를 하여 작성한다.
 주석규칙
– Session Bean
• 프로그램개발표준예제/주석규칙 폴더에 [주석처리_세션빈.java] 참조
[그림] 주석처리_세션빈.java 의 일부분 발췌
2.1 코딩규칙
–
JSP
• 프로그램개발표준예제/주석규칙 폴더에 [주석처리_JSP.jsp] 참조
[그림] 주석처리_JSP.jsp 의 일부분 발췌
2.2 명명규칙 ( JSP )
JSP 명명규칙
단위업무 ID
단위업무
일련번호
(세자리)
[업무분류기준_v1.0.xls] [프로그램목록.xls]
참조하여 부여
참조하여 부여
구분자
-
화일
일련번호
(두자리)
작업구분에 상관없
이 순차적으로 부
여 01, 02, 03 …
구분자
-
작업구분
화면구성
p
DB 확정작업(입력/수정/삭
제)
u
프레임
f
조건화면
c
기타 작업
e
* 한 업무내의 여러 jsp에서 사용하는 공통 jsp 명칭은 단위업무ID+코멘트(full name) 으로 한다.
Ex) rem_search_condition.jsp
2.2 명명규칙 ( XML)

SQL XML 명
– Group 명
• 업무명
• group의 하위 그룹은 필요에 따라 비즈니스 명을 사용한다.
– SQL 명
• Jsp 명 + _ + 00(serial)

서비스 명
– SQL Service 는 SQL 명과 동일하게 사용한다.
– EJB, Bean Service
• Service ID
– Waffle 에서 ejb 를 sevice 에 등록할 때 만들어진 이름 그대로 사용한다.
– 업무명 + . + Class명 + . + Method명
• Service 명
– 서비스를 표현하는 이름으로 간략한 이름으로 작성한다.
• Parameter 명
– 서비스 요청 시 필요한 parameter에 대한 영문이름을 지정한다.
– map (web 상의 모든 파라미터를 넘길때 사용한다)
2.2 명명규칙 ( EJB )
 EJB(Session Bean) 명명규칙
구분
명명규칙
용례 - 단위업무가 개인기록(phm)일 때
Package
hrms. + 단위업무 ID
hrms.phm
Home Interface
단위업무 ID(첫글자 대문자) + MgrHome
PhmMgrHome
Remote Interface 단위업무 ID(첫글자 대문자) + Mgr
PhmMgr
Bean Interface
단위업무 ID(첫글자 대문자) + MgrBean
PhmMgrBean
메소드명
execute(접두어) + 개발자정의 + Model(접미
어)
executeIssueRegiModel
JNDI
Remote Interface 명 + 메소드명
hrms.phm.PhmMgr.executeIssueRegiModel
 Session Bean 은 각 단위업무마다 하나만을 만들어서 사용하는 것을 원칙으로 한다.
2.2 명명규칙 ( 변수 )
 변수 명명규칙
– 데이터베이스에 정의된 변수명은 그대로 사용한다.
– JSP에서 table의 column과 mapping 되는 변수는 table의 column명과 동일한 소문자로 사용한다.
2.2 명명규칙 ( 프레임 )
 프레임 명명규칙(1)
topF
middleF
bottomF
topF
middleF
topF
topF
leftF
rightF
topLeftF
topRight
F
leftF
rightF
bottomF
topF
topRight
F
middleF
leftF
bottomF
bLeftF
–
bRightF
bLeftF
bRightF
bRightF
bottomF2
프레임 안에 프레임이 존재하는 경우, 즉 내부프레임인 경우 기존 프레임 명명규칙에 in 을 덮붙여서 사용한다.
• 예) inTopF, inBottomF
2.2 명명규칙 ( 프레임 )
 프레임 명명규칙(2)
topF
topRightF
leftF
leftF
rightF
topRightF
mRightF
leftF
bottomF
bRightF
bRightF