2.3 KiB
2.3 KiB
File Convention
Created Date : 10/27/2023 10:48:15
Last Update Date : 10/27/2023 18:48:15
Version 0.5
Introduction
본 문서는 메타버스 플랫폼 서버 제품 개발에 적용될 File Naming Rule 을 기술한다.
팀원간에 원할한 커뮤니케이션과 유지 보수의 효율화를 위해
가급적 일정한 규칙으로 결정하며 팀의 결정에 따라 적용 범위와그 규칙을 명시한다.
개발시 반드시 본 규정에 따라 작성 하도록 한다.
File Naming Rule은 다음의 표기법을 참고하여 정의 하기로 한다.
Hungrian case Snake case
1. 파일명 정의 (FileName Define)
- 공통 사항 단어는 기본적으로 명사나 명사형을 사용하며 형용사나 형용사형도 사용 가능.
- 언어 공통 사항
| 종 류 | 형 태 | 예 시 |
|---|---|---|
| 로그 설정 파일 | NLog.Config | NLog.Config |
| 서버 설정 파일 | ServerConfig + - + ServiceType + . + 확장자 | ServerConfig-Real.json |
| 클래스 파일 | ClassName + . + 확장자 | SkillRunner.cs |
| 핼퍼 파일 | 묶음명 + Helper + . + 확장장 | ItemHelper.cs |
| 인터페이스 묶음 파일 | 묶음명 + Interface + . + 확장자 | BaseInterface.cs |
| GetSet 묶음 파일 | 묶음명 + GetSet + . + 확장자 | ItemGetSet.cs |
| 패킷 핸들러 묶음 파일 | 묶음명 + PacketHandler + . + 확장자 | ItemPacketHandler.cs |
| 비즈니스 로그 파일 | 로그 도메인명 + BusinessLog + . + 확장자 | LoginToAuthBusinessLog.cs |
| 주요 묶음 정의 파일 | 묶음명 + _ + Define + . + 확장자 | Item_Define.cs |
| 주요 묶음 프로토콜 파일 | 묶음명 + _ + Protocol + . + 확장자 | Game_Protocol.proto |
| 주요 묶음 공용 정의 파일 | 묶음명 + _ + Define + . + 확장자 | Game_Define.proto |