search

jsg0912 / beat_warrior

0 stars 0 forks source link

Coding Standard #7

Open Nights-SDH opened 2 weeks ago

Nights-SDH commented 2 weeks ago
  1. Coding 전 해야할일
    • 자신의 Branch가 최신인지 (git pull)
    • Master Branch에서 pull 받기(git pull origin master)
    • API List에서 자신에게 필요한 함수가 다른 사람이 이미 구현해놨는지 찾아보기
  2. 금지사항
    • Naming 통일 ex) 어떤 곳에서는 Enemy, 다른 곳에서는 Monster 등 같은 대상을 다른 이름으로 하면 안됨
    • 절대 Game Object 이름으로 Logic짜지 말기 ex). if(object.name == "SkillName") => 이름바뀌면???????
    • Hierarchy 상에서 Index로 찾기 금지 => Hierarchy 바뀌면?????? c.f) UI 작업 중에 어쩔 수 없을 것 같을 때, 논의하기
    • Hard Coding 금지 => 값 바뀌면??????????????? Sol) Max값, for문 경계값, 의미있는 값 등은 모두 Constant File만들어서 예외) Index 시작 0(단, 이 0도 의미가 있는 경우에는 Constant화 해야함) 등
    • 중복 코드 줄이기 => 함수화
    • 중요 변수를 여러 곳에서 관리하면 안됨
  3. 권고사항
    • 되도록이면 동사를 맨 앞에 ex) UIUpdate -> UpdateUI
    • 임시 코드이면 주석으로 TODO와 함께 임시코드라고 명시하기
    • Commit 시 최대한 작업물 별로 나눠서 Commit Message 따로 작성하기
    • If문 안에 들어가는 논리식이 복잡하거나 의미를 알기 어려운 경우 함수화하기
    • 함수 이름은 조건의 의미를 담아서 ex) If( number < 3 or height > 5) { ... } => 이 경우 왜 x가 3보다 작아야하고 y가5보다 커야하는지 모름 -> 함수화해서 이름을 잘 지어주기
    • 하나의 클래스가 너무 많은 일을 하면 안됨 => 최대한 Class 나누기