Java 개발을 위한 코드 사양에 대한 자세한 설명

Java 개발 시 준수해야 할 코딩 표준은 일반적으로 다음 7가지 사항을 포함합니다. 명명 사양, 주석 사양, 들여쓰기 형식 사양, 파일 이름 사양, 선언 사양, 명령문 사양 및 프로그래밍 사양입니다. [추천 학습: java 비디오 튜토리얼]

1. 명명 규칙

(1) 모든 식별자에는 ASCII 문자(A-Z 또는 a-z), 숫자(0-9) 및 밑줄 "_"만 사용할 수 있습니다. .

(2) 고유 패키지 이름의 접두사는 항상 모두 소문자입니다. 예: www.tonysun.cc

(3) 클래스 이름은 대소문자를 혼합하여 사용하는 명사이며 각 단어의 첫 글자는 대문자입니다. 예: 토니.

(4) 인터페이스의 대소문자 규칙은 클래스 이름과 유사합니다(예: Tony).

(5) 메소드 이름은 동사 또는 동사구이며 대소문자가 혼합된 경우 첫 번째 단어의 첫 글자는 소문자이고 다음 단어의 첫 글자는 대문자입니다. 예: setNeekeName(String&neekeName).

(6) 변수 이름의 첫 글자는 소문자이고, 중간 단어의 첫 글자는 대문자입니다. 변수 이름은 짧고 기억하기 쉬워야 합니다. 예: neekeName, neekeAddress. 일회성 임시 변수를 제외하고 단일 문자 변수 이름을 사용하지 마세요.

(7) 상수 선언은 모두 대문자로 이루어져야 하며 각 단어를 연결하는 "_"가 있어야 합니다. 예: final&String&WWW_TONY_CN&=&"www.tonysun.cc";

2. 주석 사양

(1) 모든 javadoc에 대해 가능한 한 "//"를 사용합니다. 주석 "/**&*/"를 사용하십시오. "/*&*/"를 사용하여 코드 블록에 임시로 주석을 달아 보십시오.

(2) 모든 소스 파일의 시작 부분에는 파일 이름, 날짜 및 클래스의 기능 개요를 나열하는 주석이 있어야 합니다.

(3) 각 메서드에 문서 주석을 추가해야 합니다(클래스의 main() 메서드 제외).

(4) 각 속성에 주석을 달아야 합니다.

(5) 코드에 주석을 15% 이상 포함하세요.

(6) 댓글은 중국어로 되어있습니다.

3. 들여쓰기 조판 사양

(1) 60자 이상의 줄은 피하세요.

(2) Eclipse의 소스코드 서식 기능을 이용하여 코드 들여쓰기를 완성합니다(Ctrl+Shift+F).

4. 파일 이름 사양

(1) Java 소스 파일은 하나의 Java 클래스만 저장할 수 있습니다.

(2) 파일 이름은 Java 클래스 이름과 동일합니다.

(3) 클래스 파일의 코드 줄은 200줄을 초과할 수 없습니다.

5. 선언 사양

(1) 한 줄로 변수를 선언합니다.

(2) 다른 유형의 변수 선언을 같은 줄에 넣지 마십시오.

(3) 코드 블록 시작 부분에만 변수를 선언하세요.

(4) 모든 변수는 선언 시 초기화되어야 합니다.

(5) 선언된 지역 변수가 이전 수준에서 선언된 변수를 덮어쓰지 않도록 하세요.

(6) 메서드는 빈 줄로 구분됩니다.

6. 문 사양

(1) 각 줄에는 최소한 하나의 간단한 문이 포함됩니다.

(2) return 문에서는 반환 값을 괄호 "()"로 묶지 않습니다.

(3) If 문은 항상 "{" 및 "}"로 묶입니다.

(4) for 문의 초기화 또는 업데이트 절에서 3개 이상의 변수를 사용하여 복잡성이 증가하지 않도록 하세요.

(5) switch문이 아래쪽으로 실행되는 경우(break문이 없기 때문에) 일반적으로 break문 위치에 주석을 추가해야 합니다.

7. 프로그래밍 사양

(1) 인스턴스 및 클래스 변수에 공개 또는 비공개 액세스 제어를 제공하고 기본값이나 보호된 액세스 제어를 최대한 적용하지 않습니다.

(2) 클래스의 정적 변수나 메서드에 액세스하기 위해 개체를 사용하지 마세요. 대신 클래스 이름을 사용해야 합니다.

(3) 하나의 명령문에서 여러 변수에 동일한 값을 할당하지 마십시오.

(4) 여러 분기를 구현하려면 switch() 문을 사용하세요.

(5) JDBC를 사용하는 경우 java.sql.Statement 대신 java.sql.PreparedStatement 사용을 고려하세요.

(6) 객체의 상태를 설정하는 데 사용되는 메서드의 접두사는 부울 유형 객체의 상태를 검색하는 데 사용되는 메서드의 접두사가 설정되어야 하며 검색에 사용되는 메서드의 접두사는 설정되어야 합니다. 다른 메소드는 get이어야 합니다.

(7) 프로그램에서는 숫자(또는 문자)를 최대한 적게 사용해야 하며, 숫자(또는 문자)의 의미를 설명하기 위해 정적 변수를 최대한 정의해야 합니다. 프로그램에서 할당이나 비교가 필요한 경우 앞서 정의한 정적 변수를 사용합니다. 루프 제어에서 예외가 발생했습니다.

이 기사는 Java 시작하기 칼럼에서 가져온 것입니다. 학습을 환영합니다!

위 내용은 Java 개발을 위한 코드 사양에 대한 자세한 설명의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!