Java 개발 명명 규칙

1. 파일

1. 속성 파일 접미사는 ​properties 이며 java의 i18n 사양을 따릅니다.
2. 각 제품 모듈의 구성 파일은 conf 디렉터리에 있어야 합니다. ;
3. 파일 이름은 특정 의미를 가지고 있어야 하며, 운영체제 요구 사항을 충족해야 하며, 파일 이름은 영어 또는 중국어 병음으로 구성되어야 합니다. 일반 파일의 경우 단어 사이에 슬라이드를 사용하세요.

2. 명명규칙

2.1 기본규칙

1. 문자셋은 영문자 26자, 아라비아숫자(0~9), 밑줄로 구성된다. 자바에서는 클래스, 필드, 메소드, 변수, 상수 등을 최대한 문자로 표현해야 하며, 그 외의 문자는 특별한 이유 없이 사용할 수 없습니다.
2. 네이밍에는 일정한 의미가 있어야 사용하는 것이 좋습니다. 문제 도메인의 용어를 사용하면 어느 정도 자기 설명이 가능합니다.
3. 이름이 너무 길면 별칭이나 약어를 사용하여 단순화할 수 있습니다. 명명. 약어에는 의미가 있어야 하며, 이 약어의 의미는 프로젝트 전반에 걸쳐 유지되어야 합니다
4. 이름 약어에 대한 규칙(클래스명, 필드명, 변수명, 모듈명 등에 적용 가능)
1) 의 원래 문자를 모두 삭제하고, 반복되는 문자를 압축합니다. 예를 들어 버튼은 btn으로 축약됩니다.
2) 이름 충돌이 발생하면 특정 약어로 원래 소리가 유지됩니다. 예를 들어 batton은 버튼과 충돌하지 않도록 batn으로 축약합니다
5. 앞에 밑줄을 사용하지 말고, 이름 끝에 밑줄을 사용하지 마세요

2.2 상수 명명 규칙

1. 모든 문자는 대문자여야 합니다. 의미 있는 단어 조합을 사용하여 표현하고, 단어는 "_" 밑줄로 구분됩니다.
2. 이름은 16자 이내로 최대한 짧게 유지하세요

프로그램 개발 중에는 리터럴에 직접 작업하지 않는 것이 가장 좋습니다. for 루프에서 변수를 초기화하는 경우와 같은 특별한 상황에서는 상수 -1, 0, 1을 직접 사용할 수 있습니다.

예시

publicfinalintMAX_SIZE =120;
publicfinalintMAX_WIDTH =100;
publicfinalString PROPERTY_NAME="menu";

2.3 변수 명명 규칙

1. 숫자 명명에 다음과 같은 사용을 피하세요. 명명 의미가 명확하고 프로그램이 더 명확하지 않은 한 인스턴스 변수 명명에는 숫자가 없어야 합니다.
2. 변수 이름은 3. 문제 영역의 의미를 지닌 단어나 단어 조합을 사용하세요. 첫 번째 단어는 모두 소문자이고, 그 다음 단어는 대문자, 나머지는 소문자입니다(URL 등 특수 단어 제외)
4. 이름은 최대한 짧게, 16자 이내로 유지하세요
5. 수명주기가 매우 짧은 것에 더해 짧은 임시 변수를 제외하고는 변수 이름으로 단일 문자를 사용하지 않으며, 인스턴스 변수 이름을 지정할 때 단일 문자를 사용하지 마십시오. 정수형 등 일반적으로 사용되는 단일 문자형 변수는 i, j, k, m, n 문자형은 c, d, e를 사용하고 좌표는 x, y, z를 사용합니다.
6. 어떤 경우에는 변수에 유형 접두사를 추가해야 할 수 있습니다. 모든 유형 접두사는 소문자여야 하며 변수 이름의 각 단어에는 첫 글자는 대문자로 표기합니다. (URL 등의 특수 단어 제외) 일반 유형 접두사는 다음과 같습니다.

publicintwidth;
publicString fileName;
publicstaticApplicationContext context;

2.4 메소드 명명 규칙

1. 문제 도메인의 의미에 맞는 단어 또는 단어 조합을 사용합니다. 첫 번째 단어는 소문자이고 다음 단어는 대문자이며 나머지는 소문자입니다(URL과 같은 특수 단어 제외). 밑줄을 구분 기호로 사용하지 않는 특별한 이유는 없습니다.

2. Java에서 속성 메소드 이름 지정은 JavaBean의 규칙을 따릅니다. 표준:
1) Getter 방법: get+속성 이름, 부울 유형에 is+속성 이름 사용, 일부 특정 속성 이름은 is 대신 has, can을 사용하는 것이 더 나을 수 있음
2) Setter 방법: set+attribute name
3. 생성자 메서드의 명명은 클래스 이름과 일치합니다

2.5 클래스 및 인터페이스 명명 규칙

1. 문제의 의미에 맞는 단어 또는 단어 조합을 사용합니다. domain, 각 단어의 첫 글자는 대문자입니다. 나머지 글자는 소문자입니다(URL과 같은 특수 단어 제외)

2. 인터페이스의 첫 번째 문자는 Ｉ

예시

2.6 패키지 명명 규칙

publicclassFiugre
publicinterfaceFiugreContainer
publicclassStdFigure//std为Standard的缩写

1. 패키지 이름의 모든 문자는 소문자입니다.

2. 서로 다른 비즈니스를 가진 두 패키지 간에는 양방향 종속성이 없어야 합니다.

3. 논리적 계층 구조를 채택하여 종속성을 줄입니다.