Aké sú poznámky o vysvetlení, ktoré dokument Lines alebo Sections Program?

Poznámka, že riadky dokumentov alebo časti programu sa nazývajú komentáre .

Komentáre sú vysvetľujúce poznámky v rámci zdrojového kódu programu, ktorý ignoruje kompilátor alebo tlmočník. Sú iba pre ľudských čitateľov, aby lepšie porozumeli kódu. Rôzne programovacie jazyky používajú pre komentáre inú syntax:

* Jednodávky: Tieto komentujú jeden riadok kódu. Príklady zahŕňajú:

* `// Toto je jednosmerná poznámka v C ++, Java, JavaScript a mnoho ďalších."

* `# Toto je jednosmerná poznámka v Pythone, Ruby a Bash."

* Viacrstvové komentáre (blokové komentáre): Tieto komentujú viac riadkov kódu. Príklady zahŕňajú:

* `/* Toto je viacúčelová poznámka v C, C ++, Java a ďalších.

Môže preklenúť viac riadkov. */`

* `'' Toto je viacúčelová poznámka v Pythone.

Môže tiež preklenúť viac riadkov. '' '`

* `" "Toto je ďalší štýl viacúčelového komentára v Pythone." "" `

Účelom komentárov je:

* Vysvetlite účel kódu: Opíšte, čo robí funkcia, trieda alebo blok kódu.

* Clafrify Complex Logic: Rozložte komplikované algoritmy alebo kroky do menších, zrozumiteľných častí.

* Predpoklady a obmedzenia dokumentu: Všimnite si akékoľvek obmedzenia alebo podmienky, za ktorých kód pracuje.

* Poskytnite kontext: Vysvetlite zdôvodnenie určitých výberov dizajnu.

* Zanechajte poznámky pre budúce úpravy: Uľahčite to, aby ostatným (alebo sebe v budúcnosti) porozumeli a udržiavali kód.

Dobre napísané komentáre sú rozhodujúce pre čitateľnosť, udržiavateľnosť a spoluprácu kódu. Nadmerné prichádzajúce (komentovanie zjavného kódu) sa vo všeobecnosti odrádza, pretože môže zaplniť kód a sťažiť čítanie. Cieľom je pridať hodnotu porozumeniu kódu, nie prehodnotiť, čo už je jasné.

• Predchádzajúca strana: Sú textové procesory súčasťou operačného systému? 
• Ďalšia strana: Čo je titulná lišta textového procesora?