Funkcie

  1. pri názvoch sa rovnako ako pri enumoch používa “CamelCase” s veľkým začiatočným písmeno. To platí aj pre nami definované signály a sloty (ak nevieš čo sú signály a sloty tak ťa to pravdepodobne zatiaľ nemusí trápiť ;-))
  2. je zakázané implementovať funkcionalitu do hlavičkového súboru ( inline funkcie )
  3. ak je potrebne aby funkcia vracala aj chybovu hlasku aj hodnotu je dohodute pravidlo ze navratova hodnota bude reprezentovat chybu a hodnota sa bude vracat cez refrenciu
  4. Funckia by nemala presiahnut 100riadkov zdrojoveho kodu
  5. Kazdej funkcii je potrebne kontrolovat navratovu hodnotu
  6. Ak je to mozne, vyhybat sa vnaraniu zdrojoveho kodu
  7. Pisanie doxygen dokumentacie do hlavickovych suborov
  8. Uprava doxygen dokumentacie pri modifikovanie funkcie
  9. Logovanie – na logovacie výpisy používať logovací objekt EMLog a rozumne využívať všetky 4 úrovne logovania (ETRACE, EINFO, EWARN, EERROR)
  10. v .CPP aj .H suboroch musi byt pri type vstupno/vystupneho parametra napisany aj nazov premennej( ak sa parameter nepouziva, zapoznamkovat nazov ), aby bolo na prvy pohlad jasne, co premenna predstavuje
  11. Dokumentácia - Komentare a dokumentacia


Priklad vnorenia zdrojoveko hodu:

if ( value == true )
{
      if ( value2 == true )
      {
            if ( value3 == true )
            {
                  // kod
            }
      }
}


Prehladnejsia a citatelnejsia forma kodu:

if ( value == false )
{
      EERROR/EWARN/ETRACE("log");
      return resultValue;
}

if ( value2 == false )
{
      EERROR/EWARN/ETRACE("log");
      return resultValue;
}

if ( value3 == false )
{
      EERROR/EWARN/ETRACE("log");
      return resultValue;
}
 
coding/rules_k3.txt · Last modified: 2012/07/04 15:05 by 192.168.10.119
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki