Joomlaportal.fi

Yleistä => UKK eli usein kysytyt kysymykset ja vinkit => Aiheen aloitti: admin - 26.10.2007, 22:02



Otsikko: UKK: Miten kommentoin lähdekoodia (html, css tai php)
Kirjoitti: admin - 26.10.2007, 22:02
Ohjelmoinnissa on tyypillistä, että koodiin jätetään rivejä joita ei haluta näyttää käyttäjille tai suorittaa ylipäätään. Nämä kommenttirivit toimivat joko koodin rakennetta selventävä ohjeena tai sitten suoritettavan koodin sekaan jätettynä kokeilu tai testiversiona.

Joomla!n tapauksessa on tuttua tilanne, jossa jotain ohjelman kohtaa halutaan muokata, jolloin alkuperäinen rivi (tai lohko) kommentoidaan ja lisätään muokattu versio alkuperäisen viereen. Millä merkillä sitten koodia kommentoidaan riippuu täysin siitä, onko kysessä HTML-, PHP- vaiko CSS-koodi.

Oheinen listaus selventänee eri kommentointimerkintöjä.

HTML-koodin kommentointi

1. Esimerkkikoodi
Lainaus
<div class="esimerkki"></div>
2. Kommentoitu koodirivi
Lainaus
<!--<div class="esimerkki"></div>-->

CSS-määrittelyjen kommentointi

1. Esimerkkikoodi
Lainaus
div.esimerkki{}
2. Kommentoitu koodirivi
Lainaus
/*div.esimerkki{}*/

PHP-koodin kommentointi

1. Esimerkkikoodi
Lainaus
<div class="<?php echo $esimerkki ?>"></div>
2. Kommentoitu koodirivi
Lainaus
<div class="<?php /*<?php echo $esimerkki ?>*/ ?>"></div>