Chapter 12. Code Guidelines

Table of Contents

Introduction
Names
Class Names
Function Names
Variable Names
Classes
Functions
Function Arguments
Variables
Namespace
Headers
Logic Style
Const
#include organization
Conditionals
Type Casting
Assertions
Switch Statements
goto Statements
Globals and Statics
Preprocessor Macros
Compiler and Linker Warnings
Array Indexing
Parens () with Keywords and Function Policy
Comment Format
Braces
Text Formatting
Comments
DocBook Documentation
Typefaces
Referring to VE-Suite's Versions

Introduction

There is an inherent trade-off between robust, readable code and optimum performance. These coding conventions are designed to maximize code robustness and readability, possibly at the expense of optimal performance.