Primeri kode

Primeri kode prikazujejo, kako uporabiti programski element. Razvijalci jih pogosto kopirajo neposredno v svojo kodo, zato morajo biti pravilni, varni in razumljivi. Lahko so enovrstični (vpleteni v besedilo), kratki samostojni ali daljši vzorci.

• Ponazarjajte resnične naloge ciljnega občinstva, ne umetnih scenarijev.
• Začnite s preprostimi primeri, postopno dodajajte zapletenost.
• Prednost dajte pogosto uporabljenim in težje razumljivim elementom.
• Zahtevnejše razlage prihranite za vodnike po korakih.
• Dodajte uvod, ki opiše scenarij, zahteve in odvisnosti.
• Omogočite enostavno kopiranje in zagon kode.

• Koda naj bo za ponovno uporabo; jasno naj bo, kaj lahko razvijalec prilagodi. Komentar naj pojasni, kar iz kode ni očitno – brez pretiravanja.
• Prikažite pričakovani izhod (v ločenem razdelku ali s komentarji).
• Pri kodi za vmesnik upoštevajte dostopnost (npr. nadomestno besedilo).
• Varnost: preverjajte uporabnikov vnos, gesel nikoli ne kodirajte trdo, uporabljajte orodja za statično analizo. To je še posebej pomembno v okviru KRITIS/NIS2 (glej KRITIS/NIS2).
• Obravnavo izjem prikažite le, kadar je za primer bistvena.
• Koda naj bo vedno prevedena in testirana.

The White Knight Labs – Slovenski slogovni priročnik · avtor: Wolfgang van der Stille
Vsebina je izvirno napisana za slovenščino po Slovenskem pravopisu, SSKJ in Fran. Za zgradbo (razdelitev na razdelke) je vzet zgled dela Microsoft Writing Style Guide (© Microsoft Corporation, CC BY 4.0). Ta priročnik ni Microsoftov dokument in ni povezan z Microsoftom.