Kodkomento
Kodkomento estas parto de programkodo (fontkodo, interpretita programo aŭ skripto) intencita por ula leganto, do ne por komputilo. La tradukilo aŭ interpretilo ignoras kodkomentojn [1]. Ili neniel afekcias funkcion de la programo, krom kelkaj okazoj kie ili povas kaŭzi miniuman malrapidigon. La utilo de kodkomentoj estas atentigi legantojn (aliajn programistojn aŭ eĉ sin mem) pri malevidentaj faktoj pri la programo. Amplekso de kodkomento varias de unu vorto ĝis teksto kovranta plurajn ekranojn.
Laŭ programlingvo[redakti | redakti fonton]
BASIC[redakti | redakti fonton]
10 REM This BASIC program shows the use of the PRINT and GOTO Statements.
15 REM It fills the screen with the phrase "HELLO"
20 PRINT "HELLO"
30 GOTO 20
En BASIC tradicie la vorto REM (mallongigo de "remark", esperante "rimarko") servis kiel markilo de komentoj. En pli novaj variaĵoj de la lingvo duobla '' aŭ simpla apostrofo ' sufiĉas.
LUA[redakti | redakti fonton]
En Lua duobla streketo -- indikas de resto de la linio estas komento. Krom tio disponebas aparta sintakso por plurliniaj komentoj.
Utileco[redakti | redakti fonton]
Opinioj kiel kaj kiel multe oni komentu diversas. Ĝenerale, oni ne priskribu la ĉefan funkcion de komandoj aŭ instrukcioj, ĉar ĝi estas fiksita kaj estu bone konata. Tamen malpli konatan sed en la kunteksto gravan detalon aŭ kromefikon eblas mencii. Oni skribu kion la programo faras, ne kion la instrukcio faras. Kelkaj opinias ke komentado rekte kaj plene evitendas [2].
Referencoj[redakti | redakti fonton]
- ↑ Penny Grubb, Armstrong Takang. (2003) Software Maintenance: Concepts and Practice. World Scientific, p. 7. ISBN 978-981-238-426-3.
- ↑ https://blog.codinghorror.com/coding-without-comments