[kotlin] 코틀린 스크립트에서의 코드 스타일 가이드

코틀린 스크립트를 작성할 때는 명확하고 가독성 있는 코드를 작성하는 것이 중요합니다. 이를 위해 몇 가지 코드 스타일 가이드를 따르는 것이 좋습니다. 아래에서 코틀린 스크립트의 코드 스타일 가이드를 살펴보겠습니다.

1. 들여쓰기

들여쓰기는 4칸을 사용하며 탭 대신 공백을 사용하는 것을 권장합니다. 일관된 들여쓰기 스타일을 유지하여 코드의 가독성을 높이는데 도움이 됩니다.

2. 중괄호

중괄호({})는 각 블록의 시작과 끝에 사용되어야 합니다. 한 줄짜리 블록은 중괄호 없이 작성할 수 있지만, 가독성을 위해 중괄호를 사용하는 것이 좋습니다.

3. 변수명

변수명은 소문자로 시작하고 카멜 표기법을 따라야 합니다. 변수명의 목적과 의미를 잘 전달할 수 있도록 명확하고 간결하게 작성하는 것이 좋습니다.

4. 함수명

함수명은 동사로 시작하고 카멜 표기법을 따라야 합니다. 함수의 목적과 동작을 잘 나타낼 수 있도록 명확하고 일관된 이름을 사용하는 것이 좋습니다.

5. 주석

주석은 코드의 이해를 돕는 중요한 역할을 합니다. 주석은 가능한 한 상세하게 작성하고, 코드의 동작 방식, 작성자, 수정 일자 등 필요한 정보를 포함해야 합니다.

6. 라인 길이

한 라인의 길이는 80자를 넘지 않도록 제한하는 것이 좋습니다. 너무 긴 라인은 가독성을 저하시킬 수 있으므로 필요에 따라 줄을 나누어 작성하는 것이 좋습니다.

7. 공백

연산자 주위에는 공백을 넣는 것이 가독성을 높이는 데 도움이 됩니다. 예를 들어, a + b와 같이 공백을 사용하는 것이 좋습니다.

8. import 문

필요한 클래스 또는 패키지를 import 할 때는 한 줄에 하나의 클래스 또는 패키지를 작성하는 것이 가독성을 높이는 데 도움이 됩니다.

9. 예외 처리

예외 처리는 코드의 안전성을 보장하는 중요한 부분입니다. 예외 처리를 할 때는 실제 예외 상황을 처리하는 로직과 별개로 에러 메시지를 제공하는 것이 좋습니다.

이외에도 다양한 코드 스타일 가이드가 존재하며, 프로젝트에 따라 조금씩 다를 수 있습니다. 이러한 가이드는 코드의 일관성과 가독성을 높이는 데 도움이 되므로, 가능한 한 준수하여 작성하는 것이 좋습니다.

참고 자료