06 - Kommentarer och luft

Kommentarer och luft


Den här delen kommer att handla om hur man lägger in kommentarer och luft i källkoden för att göra koden mer läsbar och lättförstålig. Kommentarer är text i koden som inte översätts av kompilatorn, de är till för att man ska första vad koden egentligen gör när man tittar tillbaka på sitt program efter en månad eller så.

Det är alltid bra att skriva kommentarer i koden, men det är också väldigt viktigt att välja bra namn på variabler och funktioner. Med dessa tre enkla saker kan man enkelt göra koden oändligt mycket mer läsbar. På detta sätt undviker man också problem längre fram i kodandet och hittar lättare problem i koden.

Här är ett program med kommentarer:

  1.  
  2. // Inkuludera bibliotek
  3. #include<iostream>
  4.  
  5. // Använd funktionen cout från namnrymden std
  6. using std::cout;
  7.  
  8. // Huvudfunktionen
  9. int main() 
  10. { 
  11.   // Det här är en kommentar 
  12.   cout << "Skriv ordentligt med kommentarer nu!";
  13.   /*
  14.   Vill man skriva långa texter i kommentarer...
  15.   kan man göra kommentarer som sträcker sig över flera rader...
  16.   genom att använda detta syntax
  17.   */
  18.  
  19.   return 0;
  20. }
  21.


Om man skriver två snedstreck så behandlas resten av den raden som en kommentar och läses inte in av kompilatorn.
Man kan även använda kommentarer som sträcker sig över flera rader. Man börjar med /* och avslutar sedan med */

När jag pratar om luft så menar jag att man ska indentera (skjuta in) koden i kodblocken (texten mellan {} ).
All kod i main-funktionen ska t ex vara indenterad (inskjuten) ett snäpp. Om man lägger till en if-stats i main-funktionen (ytterligare en nivå av {} ) så ska koden i if-satsen vara inskjuten ännu ett steg. Vad en if-sats är för något kan ni läsa om i följande delar.

Här kommer en kodsnutt med korrekt inskjutna rader, du behöver inte förstå vad koden gör bara lägg märke till systemet i hur man skjuter in texten:

  1.  
  2. #include<iostream>
  3.  
  4. using std::cout;
  5. using std::cin;
  6.  
  7. int main() 
  8. { 
  9.   int ett_tal;
  10.   cin >> ett_tal;
  11.  
  12.   if (ett_tal == 1)
  13.   {
  14.     cout << "Det är ju mitt favorittal!\n";
  15.   }
  16.  
  17.   return 0;
  18. }
  19.


Som ni märker så är inte raderna med using inskjutna eftersom de inte står mellan några {}-tecken.

Om man struntar i att skjuta in sin kod överhuvud taget kommer den bli helt oläslig efter ett tag. Kod som är oläslig är jobbig och tråkig att arbeta med, och man vill ju inte att programmeringen ska bli jobbig och tråkig!

Källa: http://blinkenlights.se/