Translations:KDevelop4/Manual/Working with source code/117/en

    From KDE UserBase Wiki
    Revision as of 05:00, 18 April 2018 by FuzzyBot (talk | contribs) (Importing a new version from external source)
    (diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

    Good code is well documented, both at the level of the implementation of algorithms within functions, as well as at the level of the interface — i.e., classes, (member and global) functions, and (member or global) variables need to be documented to explain their intent, possible values of arguments, pre- and postconditions, etc. As far as documenting the interface is concerned, doxygen has become the de facto standard for formatting comments that can then be extracted and displayed on searchable webpages.