Nutz Java 인 코딩 규범(V 1.0)

Nutz Java 인 코딩 규범(V 1.0)
  • 10.규범 의 규범
  • 21.코드 형식

  • 3.2.명명
  • 3.12.1 팩
  • 3.22.2 류 와 인터페이스
  • 3.32.3 멤버 변수
  • 3.42.4 상수
  • 3.52.5 국부 변수
  • 3.62.6 구성원 함수 와 정적 함수

  • 주석
  • 4.13.1 클래스 Java Doc
  • 4.23.2 함수 Java Doc
  • 4.3.3 필드 Java Doc
  • 4.43.4 함수 내부 주석
  • 54.프로 그래 밍
  • 65.단원 테스트
  • 0.규범 적 인 규범
    Top
  • 본 규범 의 모든 항목 은 반드시 이의 성 이 없고 집행 할 수 있어 야 한다.그렇지 않 으 면 폐기
  • 본 규범 의 항목 은 두 단계 로 나 뉜 다.
  • 규칙- R
  • 건의- S

  • 본 규범 의 모든'규칙'항목 은 반드시 준수 되 어야 한다
  • 1.코드 형식
    Top
  • R-통 일 된 Eclipse 코드 형식 사용: https://github.com/nutzam/nutz/blob/master/doc/eclipse/nutz-eclipse-java-code-format-1.0.xml
  •  github 프로젝트 중 이 파일 가 져 오기
  • S-비 Eclipse 사용 자 는 상기 XML 코드 를 읽 고 스스로 준수 하 십시오.
  • 기본적으로 저 희 는 비 Eclipse 사용자 에 게 규범 을 지정 하지 않 았 습 니 다.저 희 는 아직 좋 은 방법 이 없습니다

  • 2.명명
    Top
    가방
    Top
  • R-가방 이름 은 모두 소문 자로 2 개 이내 의 단 어 를 써 야 한다.
  • S-단수 명사 1 개
  • 가 좋 습 니 다.
  • R-모든 항목 의 가방 은'org.nutz'를 부모 로 포장 해 야 합 니 다.

  • 2.2 클래스 와 인터페이스
    Top
  • S-명사
  • R-이름 클래스 와 인터페이스 일 때 모든 단어의 이니셜 을 대문자 로 써 야 합 니 다.
  • R-인터페이스의 이름 은 이니셜 이 I 이거 나 IF 접 두 사 를 붙 이 는 이름 방식 을 사용 하지 않 습 니 다.예 를 들 어 IBookDao,BookDaoIF 등.
  • R-추상 류 는 Abstract 를 클래스 이름 의 접두사 로 사용 해 야 하고 인 터 페 이 스 는 인터페이스 이름 접두사 로 사용 하 는 것 을 권장 합 니 다.
  • R-이상 클래스 는 Exception 을 이름 접미사 로 사용 해 야 합 니 다.
  • R-한 번 실행 하면 버 리 는 클래스 라면 ing 으로 끝 납 니 다.예 를 들 어 Rendering
  • R-클래스 이름 은 가능 한 한 짧 지만 줄 임 말 을 하지 않 는 것 이 좋 습 니 다.줄 임 말 이 있 으 면 org.nutz.dao.cnd 와 같은 특별한 클래스 를 사용 해 야 합 니 다.
  • 호출 자가 당신 의 유형 명 을 너무 길 게 쓰기 때문에 그의 IDE 가 자동 으로 그(그녀)를 대신 해서 줄 을 바 꿀 것 입 니 다.그 는 약간 불쾌 할 것 입 니 다
  • R-클래스,Object,String 등 자바 의 표준 라 이브 러 리 와 충돌 하지 마 십시오.
  • 충돌 하면 자바 표준 라 이브 러 리 의 디자인 을 매우 무시 한 다 는 뜻 이다
  • 호출 자 는 표준 라 이브 러 리 에 있 는 것 이 아니 라 그 가 사용 하 는 것 이 당신 의 클래스 라 는 것 을 명 확 히 하 는 데 더 많은 시간 과 코드 가 필요 합 니 다
  • S-이하 의 경우 이상 한 유형 을 쓸 수 있 습 니 다- 명칭 이 짧 아서 한눈 에 무슨 뜻 인지 모 르 겠 지만,사용 하면 한눈 에 무슨 뜻 인지 알 수 있다.
  • 류 특별 상용
  • 류 는 매우 특수 하여 분류 하기 어렵다
  • 사유 류 또는 내부 류
  • 다른 사람 이 호출 하 는 공유,보호,기본 클래스 를 추천 하지 않 습 니 다.
  • 이상 한 이름 을 지 었 는데 이런 코드 에 관심 을 갖 고 싶 지 않다 는 것 이다

  • R-결 성 인터페이스 구현 은 Default 이름 접 두 사 를 사용 해 야 합 니 다.예 를 들 어 DefaultEntityMaker.
  • 임 플 릿 을 접미사 로 사용 하여 이 인터페이스의 최 적 화 된 실현 또는 유일한 실현
  • 을 나 타 낼 수 있다.

    2.3 멤버 변수
    Top
  • S-단수 명사
  • 가 좋 습 니 다.
  • R-private 를 할 수 있 으 면 default 을 원 하지 않 고 default 을 할 수 있 으 면 protected 를 원 하지 않 으 며 Public
  • 을 원 하지 않 는 것 이 좋 습 니 다.
  • R-집합 이나 배열 이 라면 복수 명사 로
  • 지도 pets,지도 petMap 보다 낫다
  • R-알파벳 을 사용 하지 마 세 요.특히 i 는 index 나 cursor 로 대체 할 수 있 습 니 다
  • 2.4 상수
    Top
  • R-이름 상수(final 수정자 가 있 는 도 메 인)를 구분 해 야 합 니 다.public final int MAXVALUE = 30 。

  • 2.5 부분 변수
    Top
  • R-국 역 변수 이름 은 가능 한 한 짧게 하고 줄 임 말 을 추천 합 니 다.예 를 들 어 StringBuilder sb
  • R-전체적으로 말 하면 국부 변 수 는 마음대로 명명 하 십시오.짧 을 수록 좋 습 니 다
  • 예 를 들 면 이게 안 좋아요.
     public String abc(String str){
    	AbcObjectSet abcObjectSet = new AbcObjectSet();
    	abcObjectSet.setName(str);
    	return abcObjectSet.getBrief();
     }
    

    이것 은 쉽게 읽 을 수 있다.
     public String abc(String str){
    	AbcObjectSet aos = new AbcObjectSet();
    	aos.setName(str);
    	return aos.getBrief();
     }
    

    2.6 구성원 함수 와 정적 함수
    Top
  • R-setter/getter 를 제외 하고 다른 함 수 는 동사 나 동명 구
  • 를 사용한다.
  • S-이하 의 경우 이상 함 수 를 쓸 수 있 습 니 다- 명칭 이 짧 아서 한눈 에 무슨 뜻 인지 모 르 겠 지만,사용 하면 한눈 에 무슨 뜻 인지 알 수 있다.
  • 함수 특별 상용
  • 함수 가 매우 특수 하 다
  • 개인 함수 나 기본 함수
  • S-체인 할당 을 지원 하 는 setter 는 작성 을 허용 하고 같은 이름 의 getter
    // Setter
    public Pet name(String name){
    	this.name = name;
    	return this;
    }
    
    // Getter
    public String name(){
    	return this.name;
    }
    
  • 도 지원 합 니 다.
    3.주석
    Top
  • R-주석 은 코드 와 동기 화 되 어야 합 니 다.
  • R-주석 중의 첫 번 째 문장 은(영어)마침표,물음표 또는 느낌표 로 끝난다.자바 성 도 구 는 설명 의 첫 번 째 문장 을 방법 집합 표 와 색인 에 넣 습 니 다.
  • R-주석 에 한 단락 이 넘 으 면

    탭 으로 구분 합 니 다.

  • R-주석 에 여러 장 이 있 으 면 각 장의 제목 을

    태그 로 설명 합 니 다.

  • R-주석 이 줄 을 바 꿔 야 할 경우
    탭 을 사용 합 니 다.
  • R-예시 코드 는
    로 감 싸 줍 니 다.

  • 3.1 클래스 Java Doc
    Top
  • R-유명 작가,형식 은@Author XiaoMing([email protected])
  • R-계승 하 는 방법 은 주석 을 생략 할 수 있 지만 계승 되 는 방법 은 주석 이 있어 야 한다.

  • 3.2 함수 Java Doc
    Top
  • R-간단 한 get/set 방법 은 주석 을 생략 할 수 있 습 니 다.
  • R-계승 하 는 방법 은 주석 을 생략 할 수 있 지만 계승 되 는 방법 은 주석 이 있어 야 한다.

  • 3.3 필드 Java Doc
    Top
  • R-더 이상 설명 이 없습니다
  • 3.4 함수 내부 주석
    Top
  • R-줄 주석 과 블록 주석 은 모두 받 아들 일 수 있다
  • R-JAVA DOC 쓰 지 마,의미 없어
  • R-코드 품질 이 좋 지 않 지만 정상적으로 작 동 하거나 아직 실현 되 지 않 은 코드 는'//TODO:'
  • R-if..else..분기 에 주석 형식 을 쓰 려 면 다음 과 같 아야 합 니 다.
    // comments for case A
    if(xxxx){
    	//TODO you code here
    }
    /*
     * Multipline comments for case B
     */
    else if(xxxxx){
    	//TODO you code here
    }
    // comments for default case
    else{
    	//TODO you code here
    }
    
  • 4.프로 그래 밍
    Top
  • R-제출 할 때마다 컴 파일 이 통과 되 어야 합 니 다
  • R-제출 할 때마다 JUnit 테스트 를 통과 하 는 것 이 좋 습 니 다.
  • 특별한 상황 이 없 는 한-예 를 들 어 다른 사람과 공유 해 야 할 수정
  • R-언제나 같은 기능,더 짧 은 코드 가 더 긴 코드 보다 좋 습 니 다.
  • 이곳 의'짧 음'은 주로'논리'가 짧 은 것 이지'문자 길이'가 짧 은 것 이 아니다
  • .
  • R-코드 를 삭제 하 는 공헌 은 코드 를 추가 하 는 공헌 보다 크 고 적어도 그것 보다 작 지 않다
  • R-과도 한 디자인 피하 기
  • 코드 가 작 동 하도록 한 다음 에 아름 다운 코드 로 재 구성
  • '인터페이스'가 구 조 를 고정 시 켰 다 는 것 을 알 아야 한다.'클래스'가 아니 라 인터페이스 로 진화 할 때 고정 된다
  • .
  • 코드 구조 디자인 은
  • 에 따라 야 합 니 다.

    5.유닛 테스트
    Top
  • R-용례 명 은'긴 이름'-한 마디 로 밑줄 긋 기공백 대신
  • 이 이름 을 통 해 테스트 가 무엇 을 하 는 지 기본적으로 알 수 있다
  • R-주요 인터페이스 와 실현 클래스 는 가능 한 한 많은 용례 로 덮어 써 야 한다
  • 좋은 웹페이지 즐겨찾기