즉시 적용할 수 있는 간단하지만 강력한 코딩 방법: 들여쓰기 및 공백

강력한 코딩 실습 시리즈를 계속하면서 오늘은 코드의 가독성을 크게 향상시킬 수 있는 두 가지 간단한 개념에 대해 이야기하겠습니다.

적절한 들여쓰기 유지

A source file is a hierarchy rather like an outline. Each level of this hierarchy is a scope into which names can be declared and in which declarations and executable statements are interpreted. - quote from Clean Code book - Robert C. Martin

들여쓰기를 사용하여 코드에서 이러한 계층 구조를 시각적으로 식별합니다. 올바르게 들여쓴 코드는 위에서 아래로 읽기 쉽고 전체 프로젝트에서 일관성을 유지해야 합니다.

다음 코드를 고려하십시오.

class Payment {
let paymentPerHour: Double

init(paymentPerHour: Double) {self.paymentPerHour = paymentPerHour}

    private func normalHours(from workingHours: Int) -> Double {
return workingHours > 8 ? 8 : Double(workingHours)}

private func overtimeHours(from workingHours: Int) -> Double {
        return workingHours > 8 ? Double(workingHours - 8) : 0}}

꽤 나쁜, 오른쪽? 우리의 뇌는 모든 방법이 시작되고 끝나는 위치를 식별하는 패턴을 찾을 수 없습니다. 이 코드를 읽는 것은 매우 어렵습니다. 그리고 읽기 어렵다는 것은 우리가 항상 새로운 코드를 작성하기 위해 코드를 읽고 있기 때문에 그것을 유지하기가 매우 어렵다는 것을 의미합니다.

적절한 식별로 해결해 보겠습니다.

class Payment {
    let paymentPerHour: Double

    init(paymentPerHour: Double) {
        self.paymentPerHour = paymentPerHour
    }

    private func normalHours(from workingHours: Int) -> Double {
        return workingHours > 8 ? 8 : Double(workingHours)
    }

    private func overtimeHours(from workingHours: Int) -> Double {
        return workingHours > 8 ? Double(workingHours - 8) : 0
    }
}

훨씬 낫다! 두 예를 비교하십시오. 코드는 둘 다 동일하지만 두 번째 코드는 올바르게 들여쓰기되었습니다.

오늘날 시장의 거의 모든 코드 편집기는 자동으로 코드에 들여쓰기를 적용할 수 있습니다. 또한 Prettier와 같은 도구를 사용하여 자동화할 수 있습니다.

공백을 사용하여 세로 분리 만들기

거의 모든 코드는 왼쪽에서 오른쪽으로, 위에서 아래로 읽습니다. 모든 줄은 진술이나 표현을 나타내며 모든 줄 그룹은 완전한 생각을 나타내야 합니다.

이러한 생각을 구분하려면 공백(원하는 경우 빈 줄)을 추가하세요. 코드가 더 읽기 쉬워졌습니다.

이전 코드가 공백 없이 작성되었다면 어떻게 될까요?

class Payment {
    let paymentPerHour: Double
    init(paymentPerHour: Double) {
        self.paymentPerHour = paymentPerHour
    }
    private func normalHours(from workingHours: Int) -> Double {
        return workingHours > 8 ? 8 : Double(workingHours)
    }
    private func overtimeHours(from workingHours: Int) -> Double {
        return workingHours > 8 ? Double(workingHours - 8) : 0
    }
}

들여쓰기가 잘 되어 있더라도 각 생각(이 코드의 방법)이 시작되거나 끝나는 위치에 대한 단서가 없기 때문에 읽기가 어렵습니다. 좋습니다. 코드 편집기의 색상은 이러한 항목(init, private func 등)을 식별하는 데 많은 도움이 되지만 공백을 올바르게 사용하면 가독성을 크게 향상시킬 수 있습니다.

결론

이 기사에서는 들여쓰기와 공백을 사용하여 코드 가독성을 높이는 방법에 대해 썼습니다. 나는 당신이 그것으로부터 약간의 통찰력을 얻었기를 바랍니다.


이 기사는 코딩에 대한 모범 사례에 대해 쓰고 있는 시리즈의 세 번째 기사입니다.


질문이 있거나 피드백을 제공하고 싶다면 아래에 댓글을 남겨주세요. 이에 대해 기꺼이 논의하겠습니다.

내 작업이 마음에 들면 구독하여 새 기사를 게시할 때 알림을 받을 수 있습니다.

고맙습니다! 좋은 하루 되세요!