Komentáre v programovom kóde

Komentáre tvoria súčasť každej aplikácie. Tak ako rôzne časti programového kódu aj komentáre majú svoje pravidlá. Okrem spôsobu ich zápisu (coding style) je potrebné sa riadiť aj ďalšími pravidlami, ktoré vytvárajú programový kód kvalitnejším a prehľadnejším.

Jedným z najdôležitejších odporúčané pre písanie komentárov je pravidlo: Namiesto dávania komentárov do zlého kódu je vhodné celý kód prepísať tak, aby bolo zjavné čo presne vykonáva aj bez použitia komentárov.

Niektorí autori sú názoru, že program by mal mať čo najmenej komentárov a mal by byť napísaný tak, aby komentáre nebolo nutné zapisovať. Žiaľ v praxi nie je táto možnosť aplikovateľná výsledkom čoho bolo vytvorených niekoľko základných typov komentárov.

Komentáre obsahujúce informácie o autorských právach

Komentáre obsahujúce informácie o autorských právach sú najčastejšie umiestnené na začiatku každého zdrojového kódu.

Príklad: Komentár zo zdrojového kódu aplikačného servera Tomcat.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed 
 * with this work for additional information regarding copyright 
 * ownership. The ASF licenses this file to You under the Apache 
 * License, Version 2.0 (the "License"); you may not use this file 
 * except in compliance with the License.  You may obtain a copy 
 * of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 
 * implied. See the License for the specific language governing 
 * permissions and limitations under the License.
 */
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed 
 * with this work for additional information regarding copyright 
 * ownership. The ASF licenses this file to You under the Apache 
 * License, Version 2.0 (the "License"); you may not use this file 
 * except in compliance with the License.  You may obtain a copy 
 * of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 
 * implied. See the License for the specific language governing 
 * permissions and limitations under the License.
 */

Informatívne komentáre

Informatívne komentáre môžu poskytovať informácie o súbore, triede alebo metóde. Súčasťou informatívnych komentárov môžu byť komentáre za účelom vysvetlenia zámeru programového kódu, prečo to je zapísané takýmto spôsobom či komentáre za účelom objasnenia, čo sa bude vykonávať a ako.

Varovné komentáre

Varovné komentáre upozorňujú na možné problémy, ktoré môžu vzniknúť ak sa nedodržia určité pravidlá. Ich cieľom je informovať programátora na čo si má dávať pozor.

Komentáre za účelom zvýraznenia dôležitosti

Komentáre za účelom zvýraznenia dôležitosti môžu slúžiť pre upriamenie pozornosti na dôležité časti programového kódu.

Komentáre pre označenie pozície

Komentáre pre označenie pozície môžu slúžiť na označenie začiatku a konca nejakej funkcionality.

Komentáre typu TODO

Komentáre typu TODO slúžia na označovanie nedokončených častí v programovom kóde.

Komentáre typu FIXME

Komentáre typu FIXME upozorňujú na problematický kód, ktorý je potrebné v blízkej budúcnosti opraviť.

Komentáre typu CHR

Komentáre typu CHR upozorňujú, že dané úpravy sú na základe požiadavky zákazníka (change request). Odporúčaný formát zápisu CHR_xxx, kde xxx je číslo alebo značka požiadavky.

Komentáre typu BUG

Komentáre typu BUG upozorňujú, že dané úpravy sú na základe reklamácie zákazníka (bug report). Odporúčaný formát zápisu BUG_xxx, kde xxx je číslo alebo značka požiadavky.

Zápisy komentárov

Komentáre majú rôzne druhy zápisov. Niektoré sú platné vo väčšine programovacích jazykov, iné sú špecifické len pre daný jazyk. Medzi veľmi často používané znaky reprezentujúce komentáre patria: //, /* */, #, , (* *).

Väčšina vývojových prostredí podporuje prácu s viacerými typmi komentárov, napríklad správu komentárov typu TODO. Vývojové prostredia tiež podporujú tvorbu záložiek, ktoré môžu nahradiť určité typy komentárov.

Príklad: Zápis komentára v jazyku HTML.

1
<!-- This is an HTML comment -->
<!-- This is an HTML comment -->

Príklad: Zápis komentára pre jazyky Java, JavaScript, PHP, Pascal, C, C++ a iné.

1
// This is a comment
// This is a comment

Príklad: Zápis komentára pre jazyky CSS, Java, JavaScript, PHP, C++ a iné.

1
2
3
/*
 * This is a multiline comment
*/
/*
 * This is a multiline comment
*/

Čím je komentár starší, tým vyššia je pravdepodobnosť, že buď nie je aktuálny alebo už nie je umiestnený na správnom mieste. V praxi je veľmi nepravdepodobné, že by programátori dokázali stále udržovať a aktualizovať všetky komentáre aj keď sa v poslednej dobe presadzujú rôzne techniky, ktorých snahou je zabezpečiť aktuálnosť všetkých komentárov.

Záver

Jasný a stručný programový kód s niekoľkými komentármi je oveľa prínosnejší ako rozsiahly a komplikovaný kód s množstvom vysvetľujúci komentárov. Je lepšie zle napísaný programový kód prepísať ako vkladať komentáre, ktoré majú jeho činnosť vysvetľovať.