Chapter 10: Generating Documentation
High-quality code is not only well written, working, and testedâit is also thoroughly documented. Documentation allows us to share information that could otherwise get lost, draw a bigger picture, give context, reveal intent, andâfinallyâeducate both external users and maintainers.
Do you remember the last time you joined a new project and got lost for hours in a maze of directories and files? This can be avoided. Truly excellent documentation will lead a complete newcomer to the exact line of code they're looking for in seconds. Sadly, the subject of missing documentation is often swept under the rug. No wonderâit takes a lot of skill and many of us aren't very good at it. On top of that, documentation ...
Get Modern CMake for C++ now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.