Back to all reviewers

Swift idiomatic naming

tensorflow/swift
Based on 3 comments
Other

Follow Swift's naming conventions to write more readable, maintainable code. The Swift language emphasizes clarity and expressiveness in naming: 1. **Avoid `get` prefixes** in function and method names. In Swift, properties and zero-argument methods serve this purpose without the prefix.

Naming Conventions Other

Reviewer Prompt

Follow Swift’s naming conventions to write more readable, maintainable code. The Swift language emphasizes clarity and expressiveness in naming:

  1. Avoid get prefixes in function and method names. In Swift, properties and zero-argument methods serve this purpose without the prefix.

    // Avoid:
    func getTimeString(_ nanoseconds: Double) -> String { ... }
       
    // Prefer:
    func timeDescription(_ nanoseconds: Double) -> String { ... }
    
  2. Name functions according to their purpose, not their return type. The return type is already declared in the function signature.

    // Avoid:
    func colorString() -> String { ... }
       
    // Prefer:
    func description() -> String { ... }
    
  3. Use Swift’s shorthand type notation for collections rather than the generic form.

    // Avoid:
    var timings: Array<Double> = [0.0]
       
    // Prefer:
    var timings: [Double] = [0.0]
    
  4. Leverage abbreviated dot syntax when the type context is already known.

    var rank: Rank = .queen  // Instead of Rank.queen
    

These conventions align with the Swift API Design Guidelines and help create a consistent codebase that other Swift developers can easily understand.

3
Comments Analyzed
Other
Primary Language
Naming Conventions
Category

Source Discussions