Allgemeiner Stil des Quelltextes

Zu diesem Punkt verbindliche Regeln zu geben ist sicher sinnlos, weil jeder seinen eigenen Stil finden muß.

Aber im Zweifelsfall sollte man seinen Stil (beziehungsweise den der Firma) dann auch möglichst konsequent einsetzen, um ein leichtes Lesen der Quelltexte und damit möglichst wenig Fehler zu ermöglichen.

• Die Kommentierung sollte einheitlich sein. Ein wilder Wechsel zwischen den verschiedenen Kommentierungsarten (/*...*/, //...) fördert nur Verwirrung.

  Viele Leute nehmen für die eigentlichen Kommentare //, und nutzen dann /*...*/, um vorübergehend ganze Bereiche eines Quelltextes stillzulegen. Das halte ich nicht für elegant, weil es erstens nicht leicht zu erkennen ist, was denn nun auskommentiert ist oder nicht, und zweitens das Stillegen nicht geschachtelt werden kann.

  Besser finde ich es, Teile des Quelltextes mit #if 0 oder ähnlichem stillzulegen, oder noch besser mit // in jeder Zeile, falls das mit einem vernünftigen Editor leicht möglich ist (mit dem EMACS ist es sehr leicht möglich):

      tuwas();
      // stillgelegt! tunix();
      // stillgelegt! for( int i=0; i<10; i++ )
      // stillgelegt!   {
      // stillgelegt!      tunix();
      // stillgelegt!   }
      // stillgelegt! tunix();
      tuwasanderes();
  

  Dabei kann neben den eigentlichen Kommentarzeichen auch gleich noch erklärender Text untergebracht werden.

  Geschachteltes Stilllegen ist ebenfalls leicht zu machen:

      // Schatz, heute nicht.  tuwas();
      // Schatz, heute nicht.  // stillgelegt! tunix();
      // Schatz, heute nicht.  // stillgelegt! for( int i=0; i<10; i++ )
      // Schatz, heute nicht.  // stillgelegt!   {
      // Schatz, heute nicht.  // stillgelegt!      tunix();
      // Schatz, heute nicht.  // stillgelegt!   }
      // Schatz, heute nicht.  // stillgelegt! tunix();
      // Schatz, heute nicht.  tuwasanderes();
  

  Manche Leute nehmen // für ,,kleine`` Kommentare in einer Zeile, und /*...*/ für mehrzeilige Kommentare. Ich sehe keinen tieferen Sinn darin, aber wer's mag!

• Die Kommentare ebenso wie Namen von Bezeichnern sollten in einer Landessprache gehalten werden.

  Dafür ist deutsch für meinen Geschmack eigentlich besser geeignet als englisch, weil man leicht zwischen selbstvergebenen Namen einerseits und (englischen) Namen aus Bibliotheken sowie C++-Schlüsselwörtern andererseits unterscheiden kann.

  Soll der Quelltext für ein internationales Publikum geeignet sein, ist natürlich Englisch die einzige akzeptable Sprache.

• Die Anweisungen innerhalb von Blöcken sollten gegenüber ihrer Umgebung angemessen (vielleicht 4 Spalten?) eingerückt werden.

  Ich bevorzuge dabei die Version, daß öffnende und schließende Klammern immer übereinander stehen:

  int main()
  {
    for( int i=0; i<10; i++ )
      {
        while( k )
          {
            printf( "Hallo!\n" );
            k--;
          }
      }
  }
  

  In letzter Zeit verwenden manche (vor allem Java-belastete) Leute eine andere Art, die Klammern zu positionieren:

  int main(){
      for( int i=0; i<10; i++ ){
          while( k ){
              printf( "Hallo!\n" );
              k--;
            }
        }
  }
  

  Ich finde das sehr unübersichtlich (aber mir muß es ja nicht gefallen).