1️⃣ Naming Convention

Code Convention

• Drawable Resource
  • 기본 순서: [접두어]_[기능/화면]_[설명]_[상태/크기].확장자
  • 접두어: 파일의 종류 (ic, img)
  • 기능/화면(생략가능): 어디에 쓰이는지, 혹은 무엇인지
  • 설명: 구체적인 모양이나 행동
  • 상태/크기(생략가능): 선택됨(_selected), 채워짐(_filled), 크기(_24), 색(_white) 등
• strings.xml

  • 공통 - 앱 전체에서 쓰임

    접두어	설명	예시
    action_	버튼이나 메뉴의 동작	action_ok, action_cancel, action_save
    label_	입력창 제목, 짧은 라벨	label_name, label_email, label_password
    title_	공통 다이얼록, 팝업 제목	title_notice
    placeholder_	입력창 힌트 (placeholder)	hint_email_input
    error_	에러 메시지	error_network_connection, error_invalid_format
    msg_	일반 안내 메시지 (토스트, 다이얼로그 내용)	msg_delete_confirm, msg_loading

  • 화면별 - 특정 화면 전용

    • [화면명]_[요소]_[설명] 순서
    • ex. 로그인: login_title, login_btn_kakao, login_msg_failed
    • ex. 마이페이지: mypage_menu_notice, mypage_profile_edit

2️⃣ Jetpack Compose Style

• Composable 함수: PascalCase (명사형 권장)

  • 함수지만 UI를 그리는 객체처럼 취급하기 때문
  • @Composable fun MyPageScreen() { ... } (O)
  • @Composable fun drawMyPage() { ... } (X - 동사형 지양)

• 이벤트 핸들러: on + Subject + Event 순서

  • on: 이벤트 핸들러임을 나타내는 접두어 (고정)
  • 대상 (생략 가능): 무엇이 변했거나 클릭되었는지 명시 (컨텍스트가 명확하면 생략)
  • 행위 (필수): 클릭됨, 변함, 포커스됨 등 일어난 사건
  • 예: onClick, onValueChange, onProfileClick

• Modifier 파라미터: 모든 Composable 함수는 modifier를 파라미터로 받아야 하며, 첫 번째 옵셔널 파라미터로 둡니다.

  @Composable
  fun ProfileImage(
      imageUrl: String,               // 필수 파라미터
      modifier: Modifier = Modifier,  // 첫 번째 옵셔널 파라미터로 Modifier 배치
      contentDescription: String? = null, // 나머지 옵셔널 파라미터들...
      shape: Shape = CircleShape,
      borderWidth: Dp = 1.dp
  ) { ... }
  

• 상태 호이스팅 (State Hoisting): 상태(State)는 내부에서 만들지 않고, 가능한 호출하는 부모가 내려주도록 설계합니다.

3️⃣ Lint & Formatting

https://developer.android.com/kotlin/style-guide?hl=ko

• Ktlint를 적용하여 코드 스타일을 자동으로 검사합니다.

4️⃣ Comment

• 코드가 무엇을 하는지 설명하는 단순 번역 주석은 지양합니다. 코드가 복잡하거나 특수한 의도가 있는 경우에만 '왜' 그렇게 작성했는지 주석을 남깁니다.
• 주석으로 설명을 덧붙이기보다, 변수명과 함수명을 명확하게 지어 코드 자체의 가독성을 높이는 것을 우선합니다.
• 당장 해결하기 어렵거나 추후 개선이 필요한 부분은 // TODO: [작성자] 내용 형식을 사용하여 남깁니다.
• 사용하지 않는(주석 처리된) 코드는 남기지 않고 삭제합니다. (Git history로 관리)