Into

Modules

Documentation

Coding Conventions

The purpose of this document is to achieve the impossible: make the work of a team of programmers look uniform. We are not going into details on why standardization is important or why we selected this stupid convention over the one you like. The discussion would be endless. All code in Into must adhere to the guidelines given here. No excuses will be accepted.

The document is divided into a the following subsections:

Indentation declares the indentation holy war over.

Naming defines the naming style in Into code.

Library code and binary compatibility gives an overview on how to write good libary code and to make code binary-compatible.

Code Templates tells more than an image. Use these and we don't need to explain header guards, copyright statements etc.

Documentation Conventions defines the style of formal and informal documentation.

Miscellaneous Conventions lists miscellaneous conventions that don't belong to anywhere else.

Notes (0)

Add a note

Not a single note added yet. Be the first, add yours.