Metadata

ID: swift-code-style/max-function-lines

Language: Swift

Severity: Warning

Category: Best Practices

Description

This rule stipulates that functions in Swift should not exceed 200 lines of code. The primary reason for this rule is to promote readability and maintainability of the code. When functions are concise and focused, they are easier to understand, test, and debug.

Long functions often indicate that a single function is doing too much. Adhering to the Single Responsibility Principle (SRP) can help avoid this. SRP states that a function should have only one reason to change. If a function is doing more than one thing, it can usually be split into several smaller, more specific functions.

In practice, to adhere to this rule, you can often break up long functions into smaller helper functions. If a piece of code within a function is independent and can be isolated, it is a good candidate to be moved into a separate function. This also increases code reusability. For instance, if a function process_data() is too long, you can identify independent tasks within it - such as clean_data(), transform_data(), and save_data() - and create separate functions for them. This makes the code easier to reason about and test, and promotes good coding practices.

Arguments

• max-lines: Maximum number of lines. Default: 200.

Non-Compliant Code Examples

// This function has >200 lines, therefore it is not compliant.
func myFunc() {
    var myVar = 1;
    






















































    


























    


























    


























    


























    


























    


























    var otherVar = 12;
}

Compliant Code Examples

// This function is <200 lines, therefore it is compliant.
func myFunc() {
    print("Hello World!");





    print("Hello Again!");
}

원활한 통합. Datadog Code Security 사용해 보기

Datadog Code Security