C/C++ Programming Style Guidelines

Fred Richards
Style guidelines and programming practices for C/C++ code for
Dynamic Software Solutions. Use the checklist at the end of this
document prior to submitting code for peer review.
" De gustibus non est disputandum. "
1. Introduction
This document contains the guidelines for writing C/C++ code for Dynamic Software
Solutions. The point of a style guide is to greater uniformity in the appearance of
source code. The benefit is enhanced readability and hence maintainability for the
code. Wherever possible, we adopt stylistic conventions that have been proved to
contribute positively to readability and/or maintainability.
Before code can be considered for peer review the author must check that it adheres to
these guidelines. This may be considered a prerequisite for the review process. A
checklist is provided at the end of this document to aid in validating the source code's
style. Where code fails to adhere to the conventions prescribed here may be considered
a defect during the review process.
If you have not already, please study Code Complete by Steve McConnell. This book
provides a detailed discussion on all things related to building software systems. It also
includes references to statistical studies on many of the stylistic elements that affect
program maintainability. Another valuable source of solid programming practice tips is
The Practice of Programming by Brian W. Kernighan and Rob Pike. Scott Meyers'