Download KDevelop User Manual

KDevelop User Manual
Chapter 9
Documentation
Documentation unfortunately belongs to the most-overlooked programming
issues. Yet, once properly set up and maintained internal and external documentation provides most valuable help.
Documentation has multiple facets. There is
• project internal documentation, mainly consisting of
– comments in header/source files
– internal API documentation of your project generated from the program file
by special tools, e.g. Doxygen
• project external documentation, comprising among others
– external API documentation of e.g. common system libraries (KDE, QtTM ,
etc.)
– any other documentation (programming language manuals, general system information, how-to articles and the like)
All this documentation should be easily maintainable and ready at hand whenever you need it. KDevelop has provisions for just this.
9.1
The Documentation Browser
75