MaeumgaGym Flutter Style Guide

네이밍

파일명

• Snake Case
• 메인기능 + 세부기능 + 파일 사용 목적
  • ex )
  • pose
    • presentation
      • screen
        • pose_detail_screen.dart
        • pose_search_screen.dart
        • pose_main_screen
      • widget
        • main
          • pose_main_list_widget.dart
        • detail
        • search

클래스

• 파일명을 따라서 UpperCamalCase로 사용한다.

Riverpod

final localTimerController =
    StateNotifierProvider<LocalTimerProvider, List<LocalTimerModel>>((ref) {
  return LocalTimerProvider();
});

class LocalTimerViewModel extends StateNotifier {
  //...
}

class LocalTimerModel {
  //...
}

변수, 함수

• lowerCamalCase로 사용한다

enum

• UpperCamalCase로 사용한다

기타

프로그래밍 권장 사항

1. 일반 print쓰지말고 log or debugPrint 사용
2. 주석 달기
3. 다중 if문 말고 switch(case) 사용(권장)
4. 3항 연산자 남발 금지
5. 수정이 되지 않는 변수는 항상 상수처리
6. 변수, 함수 타입 지정 명확히
7. Parameter를 사용할때는 항상 named로 생성
8. 코드 짤때 노란줄 띄우지 않기