NYTimes/objective-c-style-guideArchived

Features

• Objective-C - Provides a comprehensive set of naming and formatting rules tailored specifically for Objective-C codebases.
• Class Structure Organization - Standardizes the ordering of initialization and teardown methods and the use of extensions for private properties.
• iOS App Architecture References - Defines structural architectural references and design patterns for building scalable iOS applications.
• Error - Implements error handling by returning errors as explicit values instead of using error pointer arguments.
• Private Scoping - Provides standards for isolating private properties and methods using class extensions to clean up public interfaces.
• Memory Management - Establishes standards for handling object lifecycles and memory allocation within the Objective-C runtime.
• API Design Patterns - Provides architectural patterns for designing developer-facing APIs, including delegate protocols and error handling.
• Memory Qualifier Styling - Ensures consistent placement of memory qualifiers and pointer asterisks for uniform memory management style.
• Thread-Safe Implementations - Provides a synchronized shared instance mechanism to ensure thread-safe object creation.
• Protocol Parameter Standards - Standardizes the passing of the sending object as the first parameter in delegate methods to disambiguate instances.
• Naming Conventions - Defines rules for class prefixes and variable casing to prevent naming collisions and ensure clarity.
• Prefix-Based Namespace Isolation - Establishes a requirement for unique class prefixes to prevent naming collisions across different modules and libraries.
• Return-Value Error Handling - A methodology for switching on return values instead of error pointers to prevent crashes from invalid memory values.
• Source Code Formatting - Establishes standardized rules for indentation, brace placement, and whitespace to create a uniform visual structure.
• Context Passing - Defines a protocol pattern that passes the sending object as the first parameter to disambiguate multiple delegate instances.
• Project Structure Alignment - Standardizes the alignment of physical folder hierarchies with logical project groups for predictable file resolution.
• Collection Literals - Encourages the use of shorthand literal syntax for strings and collections to replace verbose constructor calls.
• Xcode Project Organization - Configures Xcode projects to align physical file structures with project groups and treat warnings as errors.
• Asset Organization - Implements a systematic naming and organization logic for image and resource assets.
• Type-Safe Enumerations - Enforces stronger type checking by assigning specific integer underlying types to enumerations.
• Asset - Defines a structured naming pattern based on purpose and state for organizing image assets.
• Constant and Enum Definitions - Provides guidelines for setting static constants and fixed underlying types for enumerations to improve type safety.
• Editor and Tooling Guides - Coding conventions for iOS development teams.
• Mobile Development Guides - Objective-C coding standards from The New York Times.
• Programming Language Standards - Style guide used by The New York Times.
• Coding Standards - Style guide for Objective-C.

Star history