4.9. Class Documentation

Like an increasing number of programming platforms, KDE allows for the ability to document code through specified comments above the class, attribute and method declarations. There is a programme, kdoc, which produces formatted HTML from these comments and I put the output from this on the developers resources page on the website[umbrello-kdoc-output]. It has proved useful for class reference but since the documentation is already directly in the code I mostly just read it direct from there. Just as useful is the error messages kdoc creates for missing documentation which help to enforce discipline among programmers to always document their code. Whenever I am working on a method or class which has not been documented I ensure that I complete the documentation immediately.