24-Interior-Mediation-System

프로젝트 개요

목적

인테리어 중개 시스템을 개발하여 최종 사용자가 만족할 수 있는 소프트웨어를 개발하는 것을 목적으로 한다.

약속

명명 규칙

공통

• 숫자로 시작되지 않는다.
• 특수문자는 언더바만 허용한다.
• 예약어를 사용하지 않는다.
• 파스칼 표기법과 카멜 표기법을 사용한다.

패키지 경로

• deu.cse.team 이하 디렉토리에 배치한다.

패키지명

• 가급적 한 단어의 명사 를 사용하며 소문자 로 표기한다.
  ex) deu.cse.team.login

클래스명

• 파스칼 표기법을 사용한다.

메소드명

• 해당 메소드가 어떤 기능을 수행하는지 명확하게 알 수 있도록 작성한다.
• GUI 또는 GUI와 관련된 기능을 하는 메소드는 파스칼 표기법을 사용한다.
• 이외에는 카멜 표기법을 사용하는 것을 권장하며, 되도록 동사+명사의 형태로 작성한다.

변수명

• 메소드의 매개변수는 카멜 표기법을 사용한다.
• 변수는 간결하지만, 약어 사용을 피하고 모든 의미를 충분히 담을 수 있도록 한다.
• 해당 클래스 또는 메소드에서 기능을 명확하게 표시하고 있어 충분히 변수의 기능에 대한 유추가 가능하지 않는 이상 한 글자로 된 이름을 사용하지 않는다.
• 선언 시점에서 초기화한다.
• 반복문에서 인덱스로 사용할 변수는 i,j,k 등으로 사용한다.