How to enforce GitHub's Objective-C style guide in Xcode?

You can integrate it manually by configuring Xcode's text editing settings for tabs and formatting, or use third-party tools like ClangFormat with custom rules based on the guide. However, since the repo is inactive, you might need to adapt it for newer Xcode versions.

GitHub Objective-C style guide vs Google's Objective-C style guide

GitHub's guide focuses more on conventions like tabs and Tomdoc comments, while Google's often uses spaces and different documentation styles. GitHub's is community-vetted but inactive, whereas Google's might be more updated for larger projects. Choose based on your team's preferences and tooling.

Best practices for Objective-C documentation comments according to this guide

The guide recommends Tomdoc-style comments, hard-wrapped at 80 characters, and documenting whether parameters allow nil. This ensures consistent and readable documentation, but you'll need to manually enforce it as automatic tools might not support Tomdoc by default.

Should I use tabs or spaces in Objective-C code?

This guide mandates tabs for indentation, arguing for consistency, but many modern teams prefer spaces for better cross-editor compatibility. If you adopt this guide, you'll need to configure your environment to use tabs, which might cause issues in collaborative settings with mixed preferences.

How to handle errors in Objective-C without exceptions

The guide advises using NSError ** parameters or ReactiveCocoa signals for errors, avoiding exceptions for flow control. This aligns with Apple's recommendations but requires careful implementation to ensure error propagation is handled consistently in your codebase.

Is GitHub's Objective-C style guide still relevant for new projects?

It's less relevant for new projects due to its inactive status and the shift towards Swift. However, for legacy Objective-C codebases or teams valuing its conventions, it can provide a solid foundation, but you should supplement it with current best practices.

Open-Awesome

GitHub Objective-C Style Guide

A comprehensive style guide and coding conventions for Objective-C projects, building upon Apple's Cocoa guidelines.

GitHub

1.7k stars241 forks0 contributors

What is GitHub Objective-C Style Guide?

GitHub's Objective-C Style Guide is a set of coding conventions and best practices for Objective-C projects. It builds upon Apple's Cocoa guidelines to provide additional rules for whitespace, documentation, declarations, expressions, and control structures. The guide aims to standardize code style across teams and improve readability and maintainability.

Target Audience

Objective-C developers working on iOS or macOS projects, particularly teams seeking consistent coding standards. It's also useful for individual developers looking to adopt industry-aligned conventions.

Value Proposition

It offers a well-structured, community-vetted extension to Apple's official guidelines, reducing ambiguity in style decisions. Developers choose it to enforce consistency, avoid common pitfalls, and align with patterns used by major open-source projects.

Overview

Archived Style guide & coding conventions for Objective-C projects

Use Cases

Best For

Teams adopting a unified Objective-C coding standard
Enforcing consistent code style in legacy Objective-C projects
Learning modern Objective-C best practices beyond Apple's documentation
Code reviews focused on style and convention adherence
Open-source Objective-C projects seeking contributor guidelines
Integrating style checks into CI/CD pipelines for Objective-C

Not Ideal For

Teams transitioning to Swift or maintaining mixed-language projects where Swift style guides are prioritized
Developers using automated code formatters like ClangFormat that enforce style without manual guidelines
Projects requiring up-to-date conventions for modern Objective-C features, as the repository is inactive
Organizations that prefer spaces over tabs, since this guide mandates tab usage

Pros & Cons

Pros

Detailed Whitespace Conventions

Specifies tab usage, newline endings, and vertical spacing to logically organize code, reducing formatting ambiguity and improving readability.

Comprehensive Documentation Standards

Enforces Tomdoc-style comments and 80-character hard-wrapping, ensuring consistent and clear documentation across the codebase.

Modern Expression Practices

Recommends object literals and dot-syntax for idempotent methods, aligning with contemporary Objective-C best practices for cleaner code.

Clear Error Handling Guidance

Advises against exceptions for flow control and promotes NSError or ReactiveCocoa signals, enhancing code reliability and maintainability.

Cons

Outdated and Inactive

The README states the repository is no longer active, meaning it may not reflect current Objective-C developments or community standards, limiting its relevance.

Rigid Formatting Rules

Mandates specific conventions like tabs over spaces and strict curly brace placement, which can conflict with other team preferences or automated tools.

Manual Enforcement Overhead

Requires manual adherence or custom tooling for compliance, unlike integrated formatters, increasing maintenance effort for teams.

Frequently Asked Questions

Related Projects

Swift Style Guide by @raywenderlich

The official Swift style guide for Kodeco.

Stars13,164

Forks2,102

Last commit1 year ago

Futurice iOS Good Practices

Good ideas for iOS development, by Futurice developers.

Stars10,976

Forks1,225

Last commit2 years ago

NY Times - Objective C Style Guide

The Objective-C Style Guide used by The New York Times

Stars5,821

Forks1,236

Last commit3 years ago

GitHub - Style guide & coding conventions for Swift projects

**Archived** Style guide & coding conventions for Swift projects

Stars4,758

Forks560

Last commit8 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub