Software Development

Swift API Design Guidelines

Apply Swift API Design Guidelines to name, label, and document Swift APIs. Covers argument label rules (prepositional phrase rule, grammatical phrase rule, first-label omission), mutating/nonmutating pair naming (-ed/-ing participle pattern, form- prefix, sort/sorted, formUnion/union), side-effect naming (noun for pure, verb for mutating), documentation comment structure (summary by declaration kind, O(1) complexity rule), clarity at call site, role-based naming, protocol naming (-able/-ible/-ing), default arguments over method families, casing conventions, and terminology. Use when designing new Swift APIs, reviewing naming and argument labels, writing documentation comments, or refactoring for call site clarity.

Publisher / source
dpearson2699/swift-ios-skills (found on skills.sh)
Upstream record
dpearson2699/swift-ios-skills
Version
Version 1
Published
Publication review
Approved for publication
Content fingerprint
f0e0ac281bad8b7f19c96a0f9f49a5c85c550b186f2d15bc811161109102bc02