Policies/Kdepim Coding Style

< Policies
Revision as of 12:23, 6 March 2013 by Guymaurel (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This document describes the recommended coding style for kdepim. Nobody is forced to use this style, but to have consistent formatting of the source code files it is strengly recommended to make use of it.

In short: Kdepim coding style follows the Kdelibs coding style.


Under Construction


Rules with test and automatic changes

- don't use any <TAB>s

 The change script makes a substitution of any <TAB> with eight spaces.
 The change works for the complete source, even within comments and strings.
 That might be to much and change the vertical alignment of the code.

- trim the lines - no twice (or more) empty lines

Migration

As discussed at KDEPIM-Treff, Berlin 3. of march 2013, all the files of KDEPIM will be reviewed to follow the coding style. This will be done over a long time, directory after directory, for each of the rules defined above. For each rules, one can find one or two script(s). The first script is to check a single file or a complete directory for all .h and .cpp files.

If present, the second script makes the changes for a single file or a complete directory for all .h and .cpp files. For some complicated situation, the script makes no change.

The scripts - don't use any <TAB>s

   coding-style-check-Tabs.sh
   coding-style-change-Tabs.sh
 The output of the check is:
   /home/guy-kde/projects/kdepimlibs/ktnef/ktnefparser.cpp
   1->308: Tab at 16:   stream_ >> i;              // i <- attribute type & name
   2->311: Tab at 16:   stream_ >> i;              // i <- data length
   3->326: Tab at 22:   case attATTACHMENT:        // try to get attachment info
   4->367: Tab at 16:   stream_ >> u;      // u <- checksum
   
 showing:
 - the name of the file which is under test.
 - the number of occurence, the line number, the position found and the line itself.

- trim the lines

   coding-style-check-Trim.sh
   coding-style-change-Trim.sh

- no twice (or more) empty lines

   coding-style-check-Twice.sh
   coding-style-change-Twice.sh
 The output of the check is:
   /home/guy-kde/projects/kdepimlibs/syndication/rss2/enclosure.cpp
   1->25: next empty line found
   2->26: next empty line found
   3->30: next empty line found
   
 showing:
 - the name of the file which is under test.
 - the number of occurence and the line number.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal