Translations:KDevelop4/Manual/Working with source code/117/da: Difference between revisions

Revision as of 07:43, 29 May 2011

Information about message (contribute)

This message has no documentation. If you know where or how this message is used, you can help other translators by adding documentation to this message.

Message definition (KDevelop4/Manual/Working with source code)

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, [http://www.doxygen.org doxygen] has become the de facto standard for formatting comments that can then be extracted and displayed on searchable webpages.

God kode har god dokumentation både af funktionernes implementering af algoritmer og af interfacet — dvs. klasser (medlems- og globale) funktioner og (medlems- og globale) variable skal dokumenteres for at forklare deres formål, mulige værdier af argumenter, pre- og postbetingelser osv. Med hensyn til dokumentation af interfacet er doxygen blevet en de facto-standard for formatering af kommentarer, som kan trækkes ud og vises i søgbare websider.