with-swift

Swift Coding Standards and Best Practices

As an AI assistant working on Swift code, I should follow these guidelines to ensure high-quality, maintainable, and efficient Swift code.

Naming Conventions

• Use descriptive names following Apple's API Design Guidelines
• Use camelCase for variables, properties, functions, and method names
• Use UpperCamelCase for types (classes, structs, enums, protocols)
• Use clear, concise names without abbreviations (unless commonly understood)
• Boolean properties should start with is, has, should, etc.
• Avoid unnecessary words or redundancy in names

// GOOD
struct UserProfile {
    var fullName: String
    var emailAddress: String
    var isVerified: Bool
    
    func refreshUserData() { ... }
}

// BAD
struct user_data {
    var nm: String
    var mail: String
    var verified: Bool
    
    func refresh_data() { ... }
}

Code Formatting and Organization

• All code produced must follow Apple's Code Formatting on its OPEN SOURCE PROJECTS

// MARK: - Properties
// MARK: - Lifecycle Methods
// MARK: - Public Methods
// MARK: - Private Methods
// MARK: - Protocol Conformance

• Use extensions to organize protocol conformance:

// GOOD
class MyViewController: UIViewController {
    // Base class implementation
}

extension MyViewController: UITableViewDataSource {
    // Table view data source methods
}

extension MyViewController: UITableViewDelegate {
    // Table view delegate methods
}

Swift Features Best Practices

Optionals

• Avoid force unwrapping (!) except in tests or when you can prove it's impossible to be nil
• Use optional binding with if let or guard let to safely unwrap
• Use optional chaining (?.) to safely access properties and methods
• Use nil coalescing operator (??) to provide default values

// GOOD
if let userName = user?.name {
    print("Hello, \(userName)")
}

let displayName = user?.name ?? "Guest"

guard let account = getAccount() else {
    return
}

// BAD
let userName = user!.name