[swift] Swift 코드 스타일 가이드

04 Dec 2023

swift

Swift는 강력하고 현대적인 프로그래밍 언어로, 코드를 작성할 때 일관된 스타일을 유지하는 것이 중요합니다. 좋은 코드 스타일은 코드의 가독성을 높이고 유지 보수성을 개선하는 데 도움이 됩니다. 이 가이드는 Swift 코드를 작성하는 데 도움이 될 일반적인 스타일 규칙과 가이드라인을 제공합니다.

들여쓰기

들여쓰기는 Swift 코드에서 가독성을 보장하는 데 매우 중요합니다. 코드 블록이나 함수 내부의 내용은 탭을 사용하여 들여쓰기합니다. 탭의 크기는 스페이스 4개로 설정하는 것을 권장합니다.

func exampleFunction() {
    if condition {
        // 코드 블록
    } else {
        // 코드 블록
    }
}

이름 짓기

변수, 상수, 함수, 클래스 등에 읽기 쉬운 이름을 지정하는 것은 효율적인 코드 작성의 핵심입니다. 명확하고 간결한 이름을 사용하여 코드의 의도와 용도를 명확하게 전달해야 합니다. 변수와 상수의 이름은 소문자로 시작하고 카멜 케이스를 사용해야 합니다. 함수와 타입의 이름은 대문자로 시작하고 카멜 케이스를 사용해야 합니다.

let maxCount = 10

func calculateSum(of array: [Int]) -> Int {
    // 코드
}

줄 길이

한 줄의 길이는 80자를 넘지 않는 것을 권장합니다. 이렇게 하면 코드를 읽을 때 수평 스크롤을 사용할 필요가 없으며 가독성이 향상됩니다. 더 긴 코드 라인은 줄 바꿈을 통해 여러 줄로 나눌 수 있습니다.

let longString = "This is a very long string that should be wrapped to multiple lines " +
                "for better readability."

줄 바꿈

줄 바꿈은 코드의 가독성을 높이는 데 큰 역할을 합니다. 특히 코드 블록 내에서 자주 사용해야 합니다. 여러 줄로 나누어진 코드 블록은 들여쓰기에 유의하여 작성해야 합니다.

func exampleFunction() {
    guard let unwrappedValue = optionalValue,
          unwrappedValue > 0
    else {
        // 코드
        return
    }
    
    // 나머지 코드
}

괄호 사용

Swift에서 괄호는 코드의 가독성을 높이기 위해 적절히 사용해야 합니다. 복잡한 표현식이나 조건문에서는 괄호를 사용하여 코드의 의도를 명확히 드러내야 합니다. 괄호 안의 코드는 들여쓰기되어야 합니다.

if (condition) {
    // 코드
}

guard (let unwrappedValue = optionalValue) else {
    // 코드
}

주석

주석은 코드를 이해하기 쉽게 만들어주는 중요한 요소입니다. 코드의 의도, 동작 방식, 알려진 문제 등을 명확하게 설명해야 합니다. 주석은 가끔 사용되지만 사용되더라도 주석 내용은 최신 상태를 유지해야 합니다.

// 이 함수는 x와 y의 합을 반환합니다.
func sum(x: Int, y: Int) -> Int {
    return x + y
}

문자열 생성

문자열 내에서 변수 또는 상수의 값을 삽입해야 할 때는 문자열 보간(interpolation)을 사용하는 것이 좋습니다. 문자열 보간은 변수나 상수를 중괄호와 함께 사용하여 값을 문자열에 삽입하는 방법입니다.

let name = "John"
let age = 25

let greeting = "안녕하세요, 제 이름은 \(name)이고, \(age)살입니다."

상수와 변수

상수(Constnats)는 변하지 않는 값을 나타내는 데 사용되며, 변수(Variables)는 값을 갱신할 수 있는 공간입니다. 가능한 한 상수를 사용하여 변경할 수 없는 값의 사용을 명확히 표현하는 것이 좋습니다.

let pi = 3.141592
var count = 0

함수

함수는 코드의 재사용성을 높이고 가독성을 개선하는 데에 매우 유용한 도구입니다. 함수는 입력을 받고, 계산을 수행하고, 결과를 반환하는 코드의 블록입니다. 매개변수와 반환 타입은 가독성을 높이기 위해 가능한 한 명확하게 명시해야 합니다.

func greet(name: String, age: Int) -> String {
    return "안녕하세요, 제 이름은 \(name)이고, \(age)살입니다."
}

위에서 제시된 스위프트 코드 스타일 가이드는 일부 일반적인 규칙과 가이드라인을 제공하며, 프로젝트와 개발팀의 요구에 따라 조정될 수 있습니다. 중요한 것은 일관된 스타일을 유지하고 가독성과 유지 보수성을 개선하는 데 초점을 맞추는 것입니다.

목차