koodilõik

A koodilõik on lühike lähtekoodi fragment, mis on avalduses või dokumentatsioonis nähtav, et selgitada mõistet, algoritmi või API kasutust. See ei pea olema täisprogrammi pikkune, kuid peaks olema loetav, korrektne ning kergesti kopeeritav katsetamiseks.

Koodilõigud aitavad lugejatel mõista süntaksit, kontrollvoogu, andmestruktuure või kuidas kasutada teeki. Need on tavaliselt lühikesed, iseseisvad ning kaasas sageli lühike selgitus või oodatav väljastus.

Koodilõigud esitatakse lugemiseks soodustavalt: monospaced font, sünteesiga süntaksivärvimine kui see on võimalik ning keelend; paljudes väljaannetes kasutatakse koodiplokke. Lõik peaks olema mõistetav ilma väliste failideta ja vältima sõltuvust keerukast seadistusest.

Parimad tavad: hoidke näide minimaalne ja fokuseeritud; kui vaja, lisage lühike kommentaar; vältige tundlike andmete või keskkonnaspetsiifilise konfiguratsiooni jagamist; veenduge, et lõik on kopeeritav ja tavapärases keskkonnas joone peal tööle pandav. Kui näide nõuab spetsiifilisi eeltingimusi, märgi need.

Näide (Python):

def greet(name):

return f"Hello, {name}!"

print(greet("World"))