How I program C

In order to maintain high-quality, readable, and maintainable code across our projects, we have established a set of guidelines.

Variables

• Naming conventions:

  • Global Constant: GLOBAL_CONST
  • Global Variables: Global_Ver
    • Struct Variable: struct_var
  • Local Variables: local_var

• Marco function: macroFunc

Functions

• Naming convention: my_functions
• Don't do early return.

• Use K&R Styles in functions:

  .c

  fn int my_func() {
  	// something
  	return int;
  }
  

Other

• Sturct: MyStruct
• Types: IntType

• Loops:

  • Use i when indexing in loop

    .c

    for (int i = 0; i < 10; i++) {
    }
    

• Switch Case

  • Add scope in cases and breaks inside them:

    .c

    switch(condition) {
    case match1: {
        // something
        break;
    }
    default: {
        // something
    }
    }
    

Reusable Names:

• Global:
  • len: Length
  • count, size
  • root: root node
  • node: links to other nodes
  • next: next node
  • img: image
  • type: enum
• Variables:
  • bg & fg: background & foreground.
  • src & dest: source & destination
  • res & req: response & request
  • x & y: x & y coordinates
  • height & width
  • theme
  • font
  • state
  • ptr: pointer
  • msg: message
  • File System:
    • file: file pointer
    • filename
    • filepath
    • path: for both file & directory path
    • dirpath
• Functions:
  • get & set: getting and setting data trough.
  • to: convert to one source to other. (eg: to_vec3_rgb)
  • alloc & free: allocate and freeing the memory
  • make, remove, update
  • print: showing the message in terminal
  • handle: Pointer opaque data in function.
  • init: initialization
• Log:
  • Level: Log levels
    • debug
    • info
    • warn: warning
    • err: error