SW
Swift API Design Guidelines
Used in 38 swift projects (avg ★631)
Details
SwiftRules
balanced
- Name types using nouns for clarity (e.g., User, AuthenticationService, Document).
- Name methods with verbs followed by nouns or objects (e.g., loadFCPXMLSample, urlForFCPXMLSample).
- Use compound names by capitalizing each word (e.g., FCPXMLSampleName, PipelineNeoTests).
- Provide descriptive parameter labels to clarify intent (e.g., forFCPXMLSample).
- Follow existing codebase patterns for consistency in services and models.
- Omit needless words in names to keep APIs concise yet clear (e.g., prefer count over elementCount).
- Group related functionality in protocols and extensions using precise, single-responsibility names.
- Ensure method signatures promise only what can be delivered, avoiding over-specificity.
- Use lowerCamelCase for properties and parameters, UpperCamelCase for types (e.g., fcpxmlSamplesDirectory).
- Align service names with domain concepts (e.g., VaultService, EncryptionService).