Home

#Welcome to the Betty wiki!

Introduction

This document describes the C coding style for Holberton School.
Coding style is very personal, and we won't force our views on anybody.
But we expect you to follow this coding style for all the projects related to Holberton School. The Holberton School coding style is mainly inspired by the Linux Kernel coding style, but it's slightly modified.
To avoid any confusion, please refer to this guide and not the official Linux Kernel coding style.

Reminder

You should be aware that by default, some text editors are using spaces instead of tabs. For instance, when you press tab key on emacs, by default, leading spaces will be put, and that will cause Betty to raise a lot of warnings. Please find some help in the Tools section of this documentation.

Summary

0. Betty cli

0.1 - Betty-style usage

0.2 - Betty-doc usage

0.3 - References

1. Coding style

1.1 - Indentation

1.2 - Breaking long lines and strings

1.3 - Placing Braces

1.4 - Placing Spaces

1.5 - Naming

1.6 - Functions

1.7 - Commenting

1.8 - Macros and Enums

1.9 - Header files

2. Documentation

2.1 - Functions

2.2 - Data structures

3. Tools

3.1 - Emacs

3.2 - Vim

3.3 - Atom