✳flâneur — a map of the web's best reading

15-410 Coding Style and Doxygen Documentation

cs.cmu.edu · 3,164 words · saved by 1 readers

Throught this course you will be working on big software projects and an important part of any large project is documentation. Documentation is especially important in group projects, like many of the projects in this class. Imagine how useful a browsable index will be when your partner is asleep and you're trying to figure out his/her code. In order to ensure that your source code has adequate documentation, we will be requiring that your code be fully documented using doxygen, a documentation system for C similar to JavaDoc. This document serves as a brief overview of doxygen and the features you will use on a regular basis. For a more detailed description of doxygen and all of its features visit the doxygen homepage. You can get detailed documentation and information about compiling and installing doxygen on a home system. There are two types of comments we want in your code. The first kind are comments at the beginning of each file which describes the file and lists things like aut

15-410 Coding Style and Doxygen Documentation Carnegie Mellon Computer Science Department 15-410 Coding Style and Doxygen Documentation Introduction Comments for Files Comments for Functions and Data Structures Coding Style / Coding Standards Description of Commands Putting it All Together Introduction Throught this course you will be working on big software projects and an important part of any large project is documentation. Documentation is especially important in group projects, like many of the projects in this class. Imagine how useful a browsable index will be when your partner is aslee

Explore this link on the map →

saved by

related reading