[카페자료창고]JAVA 명명법 & MFC 명명법 차이

JAVA 명명법 & MFC 명명법 차이

JAVA 명명법

HTML/JSP (1~9)

대분류 + 중분류 + seqNo + 속성

R : 조회 속성의 Control 파일(JSP)

U : CUD 속성의 Control 파일(JSP)

ex)

cmco1001.html :

cmco1401R.jsp :

cmco1001U.jsp

JavaScript (1~17)

단어의 첫 글자는 대문자로 시작한다

ex) Calendar.js, NumCheck.js, ExcelScript.js

JavaClass (1~22)

Class명(15) + 컴포넌트 Suffix + 유형별 Suffix

Business Component에 소속: 없음

Application Component에 소속 : App

DTO : Dto

DAO : Dao

ex) CustomerDao.java

BusinessEJB (1~22)

Class명(15) + 유형별 Suffix

- SessionBean HomeInterface + SH

- SessionBean RemoteInterface + SR

- SessionBean Bean + SB

- EntityBean HomeInterface + EH

- EntityBean RemoteInterface + ER

- EntityBean Bean + EB

- EntityBean + PK

ex) CustomerSH.java, CustomerSR.java, CustomerEH.java,

Application EJB (1~22)

Class명(15) + “App” +유형별 Suffix

- SessionBean HomeInterface + SH

- SessionBean RemoteInterface + SR

- SessionBean Bean + SB

ex) CustomerAppSH.java, CustomerAppSR.java, CustomerAppSB.java,

Component(.jar) (1~22)

업무대코드(2) + 컴포넌트 명(15) + 컴포넌트 Suffix

실제 구현되는 Package명은 업무대코드를 제외하고 모두 소문자로 표기

Jar 파일 구성 시에는 및 단어 첫 글자는 대문자로 표기

Business Component : 없음

Application Component : App

Package 예시 : arion.cs.customer

Jar 파일 예시 : CsCustomer.jar

JNDI Naming

Home Interface 명과 동일하게 정의한다.

ex) com.haki.cs.customer.session.CustomerSH

StrutsForm & Action (1~22)

대상 JSP Class 명 + Class Suffix

대상 JSP 1개당 Form, Action Class를 각 하나씩 사용함을 원칙으로 하여

개발의 일관성을 유지하도록 한다. 단, 1개의 JSP에 여러 Form이 존재하는 경우,

JSP Name + Seq No + Class Suffix(“Form”)을 사용한다.

ex) Csco2001UForm.java, Csco2402RAction.java

(동일 JSP) Csco0001U1Form.java, (동일 JSP) Csco0001U2Form.java

Class

단어의 첫글자는 대문자로 시작한다.

용어사전상의 단어를 이용하며 가능한 한 원 용어를 사용하되 단어가 지나치게

긴 경우 약어를 사용한다. 여러 단어를 연결하여 사용할 경우 단어사이의 구분을

위하여 첫 글자만을 대문자로 하고 나머지는 모두 소문자로 쓴다.

(약어도 단어사이의 혼동을 피하기 위해 첫 글자만을 대문자로 사용한다.)

단어의 배열은 [명사+명사]의 순서를 따르며, 단어사이의 구분은 '_'를 사용하지 않는다.

./ public class UserAction {

Method

Method 이름의 시작은 소문자로 하며 동사이어야 한다.

용어사전상의 단어를 이용하며 가능한 한 원 용어를 사용하되 단어가 지나치게

긴 경우 약어를 사용한다. 여러 단어를 연결하여 사용할 경우 단어사이의

구분을 위하여 첫 글자만을 대문자로 하고 나머지는 모두 소문자로 쓴다.

(약어도 단어사이의 혼동을 피하기 위해 첫 글자만을 대문자로 사용한다.)

단어의 배열은 [동사+명사]의 순서를 따른다.

단어사이의 구분은 '_'를 사용하지 않는다.

제공 Operation이 List를 반환하는 경우에는 명시적으로 식별할 수 있도록

Operation Suffix로 “List”를 명명한다.

./ public List createUser() {

변수

변수명의 시작은 소문자로 한다.

용어사전상의 단어를 이용하며 가능한 한 원 용어를 사용하되 단어가 지나치게

긴 경우 약어를 사용한다. 여러 단어를 연결하여 사용할 경우 단어사이의 구분을

위하여 첫 글자 만을 대문자로 하고 나머지는 모두 소문자로 쓰며, 약어도 단어사이의

혼동을 피하기 위해 첫 글자만을 대문자로 사용한다.

단어사이의 구분은 '_'(공백)을 사용하지 않는 것을 원칙으로 한다.

./ int cntSum;

상수

상수명은 모두 대문자를 사용한다.

용어사전상의 단어를 이용하며 가능한 한 원 용어를 사용하되 단어가 지나치게

긴 경우 약어를 사용한다. Internal Word의 구분자로 『_』을 사용한다

./ static private int USER_AVG = 35;

 

MFC 명명법

- 구조체, 클래스, enum 이름은 중복을 피하기 위해서 G(ONGAMESCHOOL의 G)로 시작하고, 단어의 첫 글자를 대문자로 사용한다.

ex> struct GVector3f, class GResourceManager

- 변수이름은 소문자로 시작하고, 그 뒤 단어의 첫 글자는 대문자로 사용한다.

ex> Vector3f vector, ResourceManager resourceMgr

- 구조체, 클래스 멤버변수 중 private인 것은 이름 뒤에 ’_’를 붙인다.

ex> int texture_;

- 이름은 되도록 사용 용도 및 의미에 맞춰서 짓고, 되도록 약자는 사용하지 않는다.

- 이름이 약자일 경우 이름을 전부 대문자로 쓰도록 한다.

ex> XMLParser

- 이름에 되도록 ‘_’는 사용하지 않는다.

Brace (괄호)

- if, while, switch등의 괄호는 다음 줄에 넘겨서 사용한다.

ex> if (…)

{

}

- if, while문 내용이 1줄일 경우 brace를 치지 않는다. 단 줄은 다음 줄로 넘긴다.

ex>

if (a > 3)

printf(…);

Space (공백)

- 연산자와 변수, 상수간에는 한 칸씩 띄운다.

ex> int a = 10;, a || b, a * b

- if, while, switch, 등의 키워드 다음에는 한 칸을 띄우고 괄호를 친다.

ex> if (…), while (…), switch (…)

- 소괄호 안에 처음과 맨 마지막은 괄호를 띄우지 않는다.

ex> if (value), switch (type)

- for문 안의 소괄호에 ;(세미콜론) 다음에는 한 칸을 띄운다.

ex> for (int i = 0; i < 10; ++i)

구조체, 클래스

- 구조체, 클래스 선언은 (생성자, 소멸자), Enum, (멤버함수 및 Operator), 멤버변수 순으로 한다.

- 클래스 inline 함수는 선언 부분에 직접 구현한다. 단, 코드 내용이 너무 길 경우 외부로

뽑을 수 있다.

코멘트 (Comment)

- 주석은 C++ 주석인 ‘//’만 사용한다.

- 파일에 관한 설명이 필요한 경우, 파일 맨 위에 아래와 같이 주석을 붙인다.

//------------------------------------------------------------------

// Descriptions

//------------------------------------------------------------------

- 함수에 대한 설명이 필요한 경우 함수 위나 옆에, 변수에 대한 설명이 필요한 경우 역시 위나 옆에 ‘//’를 이용해서 주석을 붙인다.

- 다음에 해야 할 것들에 대한 주석은 ‘// TODO: ~~~‘로 붙인다.

6. 기타

- 헤더 중복을 막기 위한 처리는 #ifndef를 사용하지 않고 #pragma once를 사용한다.

- 소스코드 맨 마지막 줄은 한 줄을 반드시 띄운다.

- 라이브러리 링크는 프로젝트 속성을 이용하지 않고, #pragma comment를 사용한다.

- 변수 초기화는 Assign을 사용하지 않고, 되도록 Initialize를 사용한다.

ex>

MyClass::MyClass()

: member_(NULL)

{

}