목차

Unity C# 스타일 가이드

이 코드 컨벤션은 마이크로소프트의 Framework Design Guidelines 및 Google C# 스타일 가이드,유니티 공식 문서를 참고하였습니다.

기본 원칙

• 코드 컨벤션의 목표는 작업의 유지보수성과 일관성을 높이는 것입니다.
• 가독성을 간결함보다 우선해야 합니다. (약간의 타이핑을 줄이려고 의미를 모호하게 하지 마세요.)
• 이름을 잘 짓는 것이 가장 중요합니다. (GPT 사용 가능합니다. 단, 너무 어려운 단어 X) (나중에 디버깅할 때 훨씬 편해집니다.)
• 코드 컨벤션은 반드시 지켜주셔야 합니다.
• 코드 컨벤션은 필요에 따라 팀 회의를 거쳐 변경될 수 있습니다.

이름 명명 규칙 (Naming)

• 가독성이 중요합니다. (의미 있는 이름을 사용하세요.)
• 변수는 명확하고 직관적인 이름을 사용하세요. (예: maxHealth, playerSpeed, damageMultiplier 등)
• Boolean 변수는 동사로 시작하세요. (예: isDead, hasItem, canMove)
• 변수 이름에서 불필요한 줄임 말을 피하세요. (읽을 수 있는 발음이어야 합니다.) (예: hp 대신 healthPoints)
• 클래스와 타입 이름은 명확해야 합니다. (예: PhysicsSolver, PlayerInventoryManager)