Flutter Code Convention

2025년 02월 05일

4분

Code Convention

Flutter Code Convention for 2025. Capstone Design

공식문서를 참고하여 작성 하였습니다.

1. 식별자 (Identifiers)

Dart에서는 식별자를 세 가지 방식으로 사용합니다.

class SliderMenu { ... }
 
class HttpRequest { ... }
 
typedef Predicate<T> = bool Function(T value);

class Foo {
  const Foo([Object? arg]);
}
 
@Foo(anArg)
class A { ... }
 
@Foo()
class B { ... }

var count = 3;
 
HttpRequest httpRequest;
 
void align(bool clearItems) {
    ...
}
 
const pi = 3.14;
const defaultTimeout = 1000;

// 파일 구조 예시
my_package/
└─ lib/
   ├─ file_system.dart
   └─ slider_menu.dart
 
// Import 접두어 예시
import 'dart:math' as math;

// 파일명에 대문자나 하이픈 사용 (Bad)
mypackage/
└─ lib/
   ├─ file-system.dart
   └─ SliderMenu.dart

긴 약어 (2글자 이상): 일반 단어처럼 취급하여 첫 글자를 대문자로 작성
예: Http (Hypertext Transfer Protocol), Nasa (National Aeronautics and Space Administration)
두 글자 약어: 영어에서 모두 대문자로 쓰이면 그대로 사용
예: ID, TV
lowerCamelCase에서 약어가 앞에 올 경우: 모두 소문자로 작성
예:

var httpConnection = connect();
var tvSet = Television();

예시 (Good):

import 'dart:async';
import 'dart:collection';
 
import 'package:bar/bar.dart';
import 'package:foo/foo.dart';
 
import 'util.dart';

import 'package:foo/foo.dart';
import 'dart:async';
 
import 'util.dart';
import 'package:bar/bar.dart';

import 'src/error.dart';
import 'src/foo_bar.dart';
 
export 'src/error.dart';

import 'src/error.dart';
export 'src/error.dart';
import 'src/foo_bar.dart';

dart format .

if (isWeekDay) {
  print('Bike to work!');
} else {
  print('Go dancing or read a book!');
}

if (arg == null) return defaultValue;

if (overflowChars != other.overflowChars)
  return overflowChars < other.overflowChars;