Presentation is loading. Please wait.

Presentation is loading. Please wait.

Class Commenting Doxygen for Classes.

Similar presentations


Presentation on theme: "Class Commenting Doxygen for Classes."— Presentation transcript:

1 Class Commenting Doxygen for Classes

2 Structured Comments Structured comments Used for: Machine readable
Automatic documentation Tooltips in IDE

3 Doxygen Format Put /** block comment before function:
@brief Description of function @param NAME what parameter called NAME is for @return What is returned @ or \ work the same or \brief)

4 File Comments Class header file (.h) get File comment Class comment
Author, other stuff? Class comment

5 Header Comments Header is public interface to our module
Where comments go! Comment public interface Anything in public Comment private Functions Variables that are not painfully obvious

6 File Comments Class implementation (.cpp) gets file comment:
Do not duplicate function comments, do comment tricky bits:

7 File Comments Other cpp files (main)
Include file description in file comment If you have global functions, comment those

8 Using Doxygen http://www.stack.nl/~dimitri/doxygen/
Extract Documentation Builds HTML help file Run HTML opens in browser


Download ppt "Class Commenting Doxygen for Classes."

Similar presentations


Ads by Google