c-coding-standard

name	c-coding-standard
description	C coding standard guidelines for names, formatting, documentation, and complexity management. Use this skill when writing or reviewing C code to ensure consistency and safety.
license	MIT

C Coding Standard

Adapted from http://www.possibility.com/Cpp/CppCodingStandard.html and NetBSD's style guidelines.

References

• Names
  • (important recommendations below)
  • Include Units in Names
  • Structure Names
  • C File Extensions
  • (other suggestions below)
  • Make Names Fit
  • Variable Names on the Stack
  • Pointer Variables
  • Global Constants
  • Enum Names
  • #define and Macro Names
• Formatting
  • (important recommendations below)
  • Brace {} Policy
  • Parens () with Key Words and Functions Policy
  • A Line Should Not Exceed 78 Characters
  • If Then Else Formatting
  • switch Formatting
  • Use of goto,continue,break and ?:
  • (other suggestions below)
  • One Statement Per Line
• Documentation
  • (important recommendations below)
  • Comments Should Tell a Story
  • Document Decisions
  • Use Headers
  • Make Gotchas Explicit
  • Commenting function declarations
  • (other suggestions below)
  • Include Statement Documentation
• Layering
• Miscellaneous
  • (important recommendations below)
  • Use Header File Guards
  • Mixing C and C++
  • (other suggestions below)
  • Initialize all Variables
  • Be Const Correct
  • Short Functions
  • No Magic Numbers
  • Error Return Check Policy
  • To Use Enums or Not to Use Enums
  • Macros
  • Do Not Default If Test to Non-Zero
  • Usually Avoid Embedded Assignments
  • Commenting Out Large Code Blocks
  • Use #if Not #ifdef
  • Miscellaneous
  • No Data Definitions in Header Files

Source: https://users.ece.cmu.edu/~eno/coding/CCodingStandard.html