Structure of Comments in Sample Source Code

The source code for each sample generally includes a standard introduction in one of the source files. This introduction consists of a block of comments in one of the source files describing what the sample illustrates, what base classes it implements, and so on. To find the introduction to the sample, go to the .cpp file whose name matches the sample. (For samples written in C, the file name ends in .c instead.) The following template shows this introduction with standard headings illustrating the elements that might be included.


// What this sample illustrates
    [brief series of 1-line descriptions]
//
// Summary
    [paragraph on what's in the sample, what it does]
//
// Demonstration instructions
    [how to bring it up, for example under GraphEdt, and make it run]
//
// Implementation
    [introduction to the code, how it all works together]
//
// Known problems ("features not illustrated by this sample"):
    [optional]
//
// Files
    [file names and a half-line description of each]
//
// Base classes used (refer to the docs for a diagram of what they inherit):
    [list of base classes directly inherited from (summary of all files)]