|
|
|
|
|
by DawsonBruce
1205 days ago
|
|
The good documentation I’m envisioning refers to standardized comments throughout the codebase (we’re working with cpp, so doxygen in this case), with code examples within the header showing how the code should be used. I’ve found there’s so many custom classes through my discovery if this codebase that it’s not quite clear how to use the classes or where to start, so having code examples along with comments describing their usage is pretty useful. It’s also nice to utilize version control for the comments, which makes them easy to contribute to, as well as hopefully inspires others to contribute their own thorough comments when designing and contributing new classes to the codebase. Documentation regarding process, coding guidelines, and the likes are better suited for a platform like confluence or some equivalent. We do that as well. |
|