Hoe om 'n opmerking in 'n rekenaarprogrammeringstaal te skryf: 4 stappe

INHOUDSOPGAWE:

Hoe om 'n opmerking in 'n rekenaarprogrammeringstaal te skryf: 4 stappe
Hoe om 'n opmerking in 'n rekenaarprogrammeringstaal te skryf: 4 stappe

Video: Hoe om 'n opmerking in 'n rekenaarprogrammeringstaal te skryf: 4 stappe

Video: Hoe om 'n opmerking in 'n rekenaarprogrammeringstaal te skryf: 4 stappe
Video: Biggy - Dames 2024, Maart
Anonim

As u op 'n rekenaar programmeer, is dit soms nodig om aantekeninge of opmerkings agter te laat sodat ander ontwikkelaars maklik deur u kode kan blaai. Of dit nou 'n open source-projek of 'n eie projek is, kommentaar is nodig om te kan koördineer met mede-ontwikkelaars en ook moontlike toekomstige ontwikkelaars. Sonder kommentaar sou die kode eenvoudig onhoudbaar wees.

Stappe

Skryf 'n opmerking in 'n rekenaarprogrammeringstaal Stap 1
Skryf 'n opmerking in 'n rekenaarprogrammeringstaal Stap 1

Stap 1. Verstaan die doel van kommentaar op 'n rekenaarprogram

  • Leesbaarheid is hier die belangrikste ding. As u na 'n opmerking kyk, moet u weet dat dit 'n opmerking is en nie 'n reël kode nie.
  • Die opmerking behoort ook nie net vir u nuttig te wees nie, maar ook vir iemand anders wat die bronkode van u rekenaarprogram kan lees.
Skryf 'n opmerking in 'n rekenaarprogrammeringstaal Skryf stap 2
Skryf 'n opmerking in 'n rekenaarprogrammeringstaal Skryf stap 2

Stap 2. Dink aan 'n kort, eenvoudige manier om u punt oor te dra

Kommentaar hoef nie 'n kunswerk te wees nie. Hulle moet bondig, netjies en reguit tot die punt wees.

Dit moet egter nie die gebruik van veelvuldige reëls vir 'n opmerking ontmoedig nie. Die punt is dat die inligting aan die leser oorgedra moet word

Skryf 'n opmerking in 'n rekenaarprogrammeringstaal Stap 3
Skryf 'n opmerking in 'n rekenaarprogrammeringstaal Stap 3

Stap 3. Skryf die opmerking met behulp van die gepaste sintaksis wat deur die programmeertaal gegee word

Skryf 'n opmerking in 'n rekenaarprogrammeringstaal Skryf stap 4
Skryf 'n opmerking in 'n rekenaarprogrammeringstaal Skryf stap 4

Stap 4. Vra jouself af of die opmerking wat jy geskryf het, gedetailleerd genoeg is

'N Opmerking moet iemand wat na die bronkode kyk, kan vertel wat daardie deel van die program eintlik doen sonder om dit saam te stel en uit te voer. Doen u opmerking dit? Gee dit al die besonderhede?

Aanbeveel: