TOPIO/BigWhoop
TOPIO/BigWhoop
4
1
Fork 0
Code Issues 26 Pull requests 1 Projects 6 Releases Packages Wiki Activity

Update 'Coding Style'

Patrick Vogler 2023-06-20 14:14:34 +00:00
parent 0db359e502
commit e9b608deb1
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
Coding-Style.md

@ -12,4 +12,23 @@
<p align="center"> <p align="center">
This document discusses practices and style for programmers working on the BigWhoop compression library. The Guidelines are based on the C Coding Style recommended by the GNOME Developer Documentation and should be followed to promote a consistent, readable, and maintainable code base. The Guide offers solutions to common C, python and cmake programming issues and illustrates through examples of code This document discusses practices and style for programmers working on the BigWhoop compression library. The Guidelines are based on the C Coding Style recommended by the GNOME Developer Documentation and should be followed to promote a consistent, readable, and maintainable code base. The Guide offers solutions to common C, python and cmake programming issues and illustrates through examples of code
</p> </p>
## Table of Contents
- [Recommended C style and coding rules](#recommended-c-style-and-coding-rules)
- [Table of Contents](#table-of-contents)
- [The single most important rule](#the-single-most-important-rule)
- [Integration with VSCode](#integration-with-vscode)
- [General rules](#general-rules)
- [Comments](#comments)
- [Functions](#functions)
- [Variables](#variables)
- [Structures, enumerations, typedefs](#structures-enumerations-typedefs)
- [Compound statements](#compound-statements)
- [Switch statement](#switch-statement)
- [Macros and preprocessor directives](#macros-and-preprocessor-directives)
- [Documentation](#documentation)
- [Header/source files](#headersource-files)
- [Artistic style configuration](#artistic-style-configuration)
- [Eclipse formatter](#eclipse-formatter)