상세 컨텐츠

본문 제목

코딩 컨벤션이란

이론공부/코틀린 문법

by 뽀사장 2024. 3. 5. 16:42

본문

728x90
반응형

 

[코딩 컨벤션이란?]

가독성을 증가시키고 유지보수가 용이하도록 코드를 작성하는 규칙이다

이 규칙으로 효율적인 협업이 가능하다

 

 

[자주 사용하는 컨벤션 (표기법)]

1. camelCase (카멜케이스) 표기법

   a. 주로 변수, 메소드의 이름을 지정할 때 사용

   b. 두단어 이상 붙여서 쓸 때 2번째 단어 부터 첫글자는 대문자로 시작한다

 

2. snake_case (스네이크케이스) 표기법

   a. 주로 상수의 이름을 지정할 때 사용

   b. 단어를 연결 할 때 _으로 연결한다

 

3. PascalCase (파스칼케이스) 표기법

   a. 주로 클래스의 이름을 지정할 때 사용

   b. 단어의 첫글자 마다 대문자로 쓴다 

 

 

[코틀린 코딩 컨벤션]

1. 저작권/라이선스

  a. 파일에 저작권 또는 라이선스 헤더가 포함된 경우 맨 위에 여러 줄로 주석을 넣어야 한다

  b. 한줄 또는 KDoc 스타일로 사용하지 않는다

 

2. 들여쓰기

   a. 새블록 또는 블록 형식 구문이 열릴 때마다 들여쓰기가 4칸씩 증가한다

 

3. 줄바꿈

   a. 코드의 열 제한은 100자이기 때문에 초과하는 줄은 줄바꿈이 되어야 한다

   b. 단 아래의 경우는 예외로 둔다

     - 열 제한 준수할 수 없는 줄 (예: KDox의 긴 URL)

     - package 및 import문

     - 잘라서 셸에 붙여넣을 수 있는 주석의 명령줄

 

 

4. 공백

   a. 섹션 구분이 필요할 때 빈 줄을 넣는다

   b. 예약어(예: if, for, catch) 뒤에 오는 여는 괄호(()

   c. 예약어(예: else, catch) 앞에 오는 닫는 중괄호 (})

   d. 여는 중괄호 ({)앞

   e. 2진 연산자의 양쪽

   f. 람다 식의 화살표 (->)

   g. 단 아래는 제외

     - 두 콜론 (::)

     - 점 구분자(.)

     - 범위 연산자 (..)

 

 

이 외에도 코틀린 코딩 컨벤션들은 더 있었지만 아직 이해가 잘 안되서 

우선 이해되는 부분만 정리했다

728x90
반응형

관련글 더보기