A Few Coding Standards
  1. Introduction
  2. Mechanical Source Issues
    1. Source Code Formatting
      1. Commenting
      2. Comment Formatting
      3. #include Style
      4. Source Code Width
      5. Use Spaces Instead of Tabs
      6. Indent Code Consistently
    2. Compiler Issues
      1. Treat Compiler Warnings Like Errors
      2. Which C++ features can I use?
      3. Write Portable Code
  3. Style Issues
    1. The High Level Issues
      1. A Public Header File is a Module
      2. #include as Little as Possible
      3. Keep "internal" Headers Private
    2. The Low Level Issues
      1. Assert Liberally
      2. Prefer Preincrement
      3. Avoid endl
      4. Exploit C++ to its Fullest
    3. Writing Iterators
  4. See Also

Introduction

Mechanical Source Issues
   Source Code Formatting


Commenting


Comment Formatting


#include Style


Source Code Width


Use Spaces Instead of Tabs


Indent Code Consistently

   Compiler Issues


Treat Compiler Warnings Like Errors


Which C++ features can I use?


Write Portable Code

Style Issues
   The High Level Issues


A Public Header File is a Module


#include as Little as Possible


Keep "internal" Headers Private

   The Low Level Issues


Assert Liberally


Prefer Preincrement


Avoid endl


Exploit C++ to its Fullest

   Writing Iterators
See Also

Chris Lattner
Last modified: Sun Oct 12 22:12:43 CDT 2003