java 개발 명명 규범 총결산

사용 전 참고 사항: 1. 객체 프로그래밍을 위한 Java의 특성 때문에 이름을 지정할 때 명사를 선택해야 합니다.
2. 낙타봉 명명법(Camel-Case): 변수명이나 함식명이 한 개 이상의 단어로 연결되어 유일한 식별자로 구성된 경우 알파벳은 소문자로 시작하고 각 단어의 알파벳은 대문자(첫 번째 단어 제외)로 시작한다.
예: myFirstName
패키지 이름의 쓰기 규범(Package)은 회사나 기구의 최고급 도메인 이름을 패키지 이름의 접두사로 추천하는데, 목적은 각 회사/기구 내에서 사용하는 패키지 이름의 유일성을 확보하는 것이다.패키지 이름은 모두 소문자로 실제 구분의 의미를 가진다.
1.1 일반적으로 1. 의미 있는 이름을 선택하면 이런 용도를 신속하게 전달할 수 있다.
2. 모든 가방의 이름은 소문자를 사용해야 한다.
1.2 실제 응용 시스템에서 층을 자주 응용하는데 Dao층(데이터베이스 접근), 서비스층(업무 처리), 웹층(페이지 제어 action 클래스)이다.
1. 가방 이름의 앞부분은 고정 명칭이고 만약에 사이트라면 사이트의 도메인 이름의 반쓰기를 사용하며 도메인 이름이 확정되지 않으면 회사의 고정 명칭을 사용한다.예: net.vschool
2. 가방 이름의 다음 단어는 모듈의 이름입니다.예: 사용자 모듈, 패키지 이름은 넷입니다.vschool.user
3. 모듈에 대한 액세스 작업은 일반적으로 다음과 같은 계층화 방식으로 나뉩니다.
Dao 레이어 작업: 일반적으로 net에 정의됩니다.vschool.xxx.dao에서 xxx는 모듈 이름입니다.
서비스 레이어 작업: 일반적으로 net에 정의됩니다.vschool.xxx.servie 중.
웹 레이어 작업: 일반적으로 넷에 정의됩니다.vschool.xxx.액션 중.
사용자 모듈의 예는 다음과 같습니다.
net.vschool.user
net.vschool.user.dao
net.vschool.user.action
net.vschool.user.service
이류명의 서술규범(Class)류명은 반드시 명사를 사용해야 한다. 만약에 한 류명에 여러 단어가 포함된다면 각 단어는 첫 번째 자모가 대문자이고 후속 자모가 소문자이며 기복이 낙타봉 모양이고 인칭은 낙타봉식이다.클래스 이름을 명명할 때에는 반드시 정확하고 간결하며 이해하기 쉽다는 것을 보증해야 한다.가능한 한 전체 단어를 사용하고 줄임말을 사용하지 마라 (모두가 공인하는 것을 제외하고)
2.1류의 명칭 2.1.1은 일반적으로 1. 의미 있는 이름을 선택하여 이 류의 용도를 신속하게 전달할 수 있도록 요구한다.
2. 자바 낙타봉 명명법을 참조하여 클래스 이름의 자모는 반드시 대문자 형식을 사용해야 한다. 만약에 클래스 이름이 여러 단어로 조합된다면 모든 단어의 자모는 대문자를 사용해야 한다.예: StudentAnswer.java
3. 인터페이스 클래스와 구현 클래스를 구별할 때 클래스 뒤에 "Impl"을 추가할 수 있다.
인터페이스 클래스: UserInterface.java 인터페이스 구현 클래스: UserInterfaceImp
4. 추천 실체류는 접두사가 없습니다.
2.1.2 실제 응용 시스템에서 층을 자주 응용하고 Dao층(데이터베이스 접근), 서비스층(업무 처리), 웹층(페이지 제어 action 클래스)을 사용하며 각 층의 클래스 이름은 가능한 한 이 층의 접미사를 달도록 한다.
1, Dao 레이어
a, 인터페이스 클래스: JavaBean+Interface+Dao의 형식으로 정의합니다. 즉, 실체 대상+Interface+Dao입니다.  
예: 사용자 객체 인터페이스 클래스: UserInterfaceDao, 여기서 xxx는 모듈 이름입니다.
b, 구현 클래스: JavaBean+Interface+Impl+Dao의 형식으로 정의, 즉 실체 대상
+Interface+Impl+Dao. 예: 사용자 객체 구현 클래스: UserInterfaceImplDao
2, 서비스 계층
a, 인터페이스 클래스: Xxx+Interface+Service의 형식으로 정의합니다. 즉, 모듈+Interface+Service입니다.    
예: 사용자 관리 인터페이스 클래스: UserMsgInterfaceServec
b, 구현 클래스: Xxx+Interface+Impl+Service의 형식으로 정의합니다. 즉, 모듈+Interface+
Impl+Service.예: 사용자 관리 구현 클래스: UserMsgInterfaceImplServec
3. 웹 레이어(action 클래스)
a, 실현 클래스: 현 Xxx+Operator+Action의 형식으로 정의한다. 즉, 모듈+조작+Action이다.... 와 같다
사용자 모듈 User+ 삭제 작업 Delete+Action = UserDeleteAction
2.1 변수의 명칭 2.2.1 일반 변수 2.2.2.1 일반적으로 1. 의미 있는 이름을 선택하면 이 변수의 용도를 신속하게 전달할 수 있다.
2. 자바 낙타봉 명명법을 참조하여 이니셜은 소문자로 시작하고 단어마다 이니셜을 대문자로 한다(첫 번째 단어는 제외).
2.2.2.2 실제 응용 1. 변수 이름은 기본 구조를 typeVariableName으로 하고 3문자 접두사를 사용하여 데이터 형식을 표시합니다.
예를 들어 성형 변수를 정의합니다: intDocCount. 그 중에서 int는 데이터 형식을 나타내고 그 다음은 표의 영문 이름이며 단어마다 이니셜을 대문자로 합니다.
데이터 유형 또는 객체 유형
변수 접두사
비고
byte
bye
1. 그룹을 만들 때 접두사 - a를 추가합니다. 예를 들어 문자열 그룹:astr,
2. 사용자 정의 유형의 변수는 자체의 이름을 사용하고 자모를 소문자로 바꿀 수 있다.
3. 명칭을 채택하는 것은 방법의 의미를 대표할 수 있어야 한다.직원 목록: employeeList
char
chr
float
flt
boolean
bln
Integer/int
int
short
sht
Long/long
lng
Double/double
dbl
string
str
2. 변수 사용 방법:
a. 한 단락의 함수에서 같은 변수를 사용하지 않고 앞뒤의 의미가 다른 두 개의 수치를 나타낸다.
b. 순환 중이지 않으면 일반적으로 하나의 알파벳을 변수 이름으로 사용하는 것을 추천하지 않습니다. i, j, k 등은 소형 순환의 순환 색인 변수로만 사용됩니다.
c. Flag를 사용하여 상태 변수의 이름을 지정하지 않습니다.
d, 다음과 같은 논리 변수를 Is로 명명합니다. blnFileIsFound.이런 부울 변수에 대한 긍정적인 형식의 명명 방식을 통해 다른 개발자들이 부울 변수가 대표하는 의미를 더욱 명확하게 이해할 수 있다. 
e, 변수 이름을 줄여야 할 때 전체 코드의 줄여쓰기 규칙의 일치성을 주의해야 한다.예를 들어 코드의 일부 구역에서 intCnt를 사용하고 다른 구역에서 intCount를 사용하면 코드에 불필요한 복잡성을 증가시킬 수 있다.변수 이름에 줄임말이 나오지 않도록 권장합니다.  
2.2.2 정적 변수 1. 의미 있는 이름을 선택하면 이 변수의 용도를 신속하게 전달할 수 있다.
2. 자바 낙타봉 명명법을 참조하여 모든 대문자 형식으로 쓰고 여러 단어로 합성된 변수에 대해'_'각 단어를 연결합니다.예: USER_LIST
2.3 방법의 명칭 2.3.1 일반적으로 1. 의미 있는 이름을 선택하면 이 방법의 용도를 신속하게 전달할 수 있다.
2. 자바 낙타봉 명명법을 참조하여 이니셜은 소문자로 시작하고 단어마다 이니셜을 대문자로 한다(첫 번째 단어는 제외).
2.3.2 실제 응용 1. 방법은 하나의 행위를 나타내는데 이것은 하나의 동작을 대표한다. 가장 좋은 것은 하나의 동사나 동사 어구 또는 첫 번째 단어가 하나의 동사이다.
2. 속성 방법: get/set으로 시작하고 그 다음에 필드 이름, 필드 이름 이니셜을 대문자로 합니다.예: getUserName()
3. 데이터 층 방법: insert(삽입),delete(삭제),update(업데이트),select(찾기),count(통계)로만 시작할 수 있으며, 다른 층 방법은 이 다섯 단어로 시작하여 오해를 사지 않도록 합니다.
4. 서비스층 방법은 방법의 행위에 따라 명명하고 방법의 의미만 설명하며 방법의 목적을 사용하지 않는다.예를 들어 시스템에 새로운 사용자를 추가하면 사용자가 프론트에 등록할 수도 있고 관리자의 백그라운드에 추가할 수도 있습니다. 방법은 다시 사용될 수 있기 때문에register를 사용하지 않는 것이 좋고add를 사용하면 더 잘 쓸 수 있습니다.웹 층과 관련된 방법을 피하십시오.
5. 웹 레이어 방법은 웹에 가까운 언어, 예를 들어register,login,logout 등 방법이 가장 좋다.
세 주석의 쓰기 규범(Javadoc) 자바는 우리가 흔히 볼 수 있는 주석 방식(/,/***/)을 사용할 수 있는 것 외에 자바 언어 규범은 우리가 말한 자바doc 주석을 정의했다. 즉, 우리가 말한 자바doc 주석은/**로 시작하고 */로 끝난다. 자바doc 주석은 자동으로 온라인 문서로 전환되어 단독 프로그램 문서를 작성하는 번거로움을 줄일 수 있다.사용을 권장합니다.
Javadoc 메모는 클래스, 속성, 메서드에 대해 주로 다룹니다.
예:

package org.ietf.jgss;
import java.net.InetAddress;
import java.util.Arrays;
/**
 *  。
 *
 * @author  
 * @version 1.0, 05/22/07
 * @since 1.0
 */
public class ChannelBinding {
/**
 *  
 */
private InetAddress initiator;
/**
 *  
 */
private InetAddress acceptor;
/**
 *  
 */
    private  byte[] appData;
   
    /**
     *  。
     *
     * @param initAddr  。
     * @param acceptAddr 。
     * @param appData 。
     */
    public ChannelBinding(InetAddress initAddr, InetAddress acceptAddr,
              byte[] appData) {
         initiator = initAddr;
         acceptor = acceptAddr;
         if (appData != null) {
              this.appData = new byte[appData.length];
              java.lang.System.arraycopy(appData, 0, this.appData, 0,
                   appData.length);
         }
    }
 
    /**
     *  
     *
     * @param obj  
     * @return  
     */
    public boolean equals(Object obj) {
         if (this == obj)
              return true;
         if (! (obj instanceof ChannelBinding))
              return false;
         ChannelBinding cb = (ChannelBinding) obj;
         return Arrays.equals(appData, cb.appData);
    }
}

4 기타 서술 규범
4.1 Jsp 페이지 이름의 쓰기 규범 1. 모두 소문자로 된 영문자와 "_"구성
2. 전체적으로 모듈 이름 + 조작의 형식을 사용한다.예: user_view.jsp
3. Jsp 페이지는 가능한 한 액션의 뜻에 대응합니다. 예를 들어 UserListAction 대응자 user_list.jsp
인터페이스:
낙타봉식으로 명명하다.명사 외에 형용사로도 명명할 수 있다(그 기능 특성을 나타낸다)
방법:
규정은 동사로 명명하여 낙타봉식으로 명명하기에 적합하지만, 유명과의 가장 큰 차이점은 자모는 반드시 소문자를 써야 한다는 것이다
변수:
명사로 규정되어 있으며, 다른 것은'방법'의 명명 방식과 같다.변수명은 매우 관건적이며 구체적인 의미를 포함하고 이해하기 쉬워야 하며, 일반적으로 하나의 자모를 변수명으로 사용하는 것을 허락하지 않는다.순환 중에 사용되는 계수기 같은 임시 변수를 제외하고는.단일 알파벳을 변수 이름으로 사용할 때 일반적으로 I, J, K는 성형 변수를 명명합니다.
상수:
모두 대문자로 표시하도록 규정되어 있다. 만약 이름이 여러 단어로 표시해야 한다면 각 단어 간에'-'로 구분된다. 상량은 반드시 의미가 명확해야 하며 상량의 의미를 나타낼 수 있다.