Documentation
Documention 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, ⪚ &doxygen;
project external documentation, comprising among others
external &API; documentation of ⪚ common system libraries (&kde;, &Qt;, &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.
The Documentation Browser