Používatelské znacky 
Základná charakteristika 
Používatelské znacky sú zapisované do kódu prostredníctvom formátovaných komentárov. Tieto 
komentáre môžu byt párové alebo nepárové. V prípade nepárového komentáru je oznacený najbližší 
blok/riadok kódu bezprostredne za znackou. Pri párových komentároch je oznacený kódy nachádzajúci sa 
medzi zaciatocným a koncovým komentárom. 
Každá znacka obsahuje volný komentár, ktorý môže v sebe obsahovat atribúty znacky. Poradie týchto 
atribútov je ignorované, pricom je podstatné najmä zachovanie citatelnosti kódu. 
Všetky znacky môžu mat priradených vývojárov pomocou @name formátu, pricom platí, že znacka môže 
mat priradený lubovolný pocet vývojárov. 
Všetky atribúty znaciek sú volitelné a v prípade potreby je ich možné použit aj viac krát. Používanie 
atribútov je však velmi odporúcané. Vdaka týmto atribútom sme schopní identifikovat najcastejšie 
kategórie chýb, predchádzat im, zlepšit vyhladávanie v kóde, atd. 
Každá znacka môže mat priradený svoj jednoznacný identifikátor, ktorý je uvádzaný na konci komentáru 
znacky za znakom ‘|’ v tvare „AutorZnacky Timestamp“. Tento identifikátor slúži na jednoznacné 
namapovanie párových znaciek a verzií znaciek napriec históriou zmien v zdrojovom súbore. Používanie 
identifikátora znaciek je však plne volitelné a je na autorovi znacky aby zvážil jeho použitie. 
Príklady znaciek 
//CODEREVIEW: @krastocny #Category(ErrorHandling) Ake typy vynimiek ocakavame? #Category(Docum 
entation) Chyba dokumentacny komentar. | someone 2014-06-17T10:48:41.2171253Z 
try 
{ 
return maintenance.AddInformationTag(informationTag); 
} 
catch (Exception e) 
{ 
//CODEREVIEW: #Category(Logging) Nevhodny typ logu. 
ServiceLogger.Info("Exception in IITMaintenance.AddInformationTag: {0}", e); 
throw e; 
} 
//<CODEREVIEW | someone 2014-06-17T10:48:41.2171253Z 
Zoznam znaciek a ich vlastností 
TODO 
Znacka urcujúca miesto v kóde, kde je potrebné doimplementovat nejakú úlohu. 
Atribúty: 
?eTask – ID úlohy z item tracking systému 
FIXME 
Oznacuje kód, v ktorom bola identifikovaná chyba. Špeciálny prípad Todo znacky. 
Atribúty 
?DTask – ID chyby z item tracking systému 
NTH 
Znacka urcujúca miesto v kóde, kde by bolo vhodné nieco dorobit. Táto práca ale nie je nevyhnutná. 
TBD 
Znacka urcujúca kód, ktorý je vo vývoji. 
Atribúty: 
?oTask – ID úlohy z item tracking systému 
SAMPLE 
Znacka vymedzujúca kód, ktorý je použitý ako príklad riešenia nejakého problému. 
REVIEW 
Oznacenie kódu, ktorý vyžaduje posúdenie skúsenejším vývojárom 
CODEREVIEW 
Oznacenie kódu, ktorý neprešiel posudzovaním 
Atribúty: 
?kCRV – id konvencie, ktoré bola porušená 
?dCategory – Kategória pripomienky 
o Documentation – dokumentácia; kód je nedostatocne zdokumentovaný 
o Name – zlé pomenovanie; premennú/triedu/... je potrebné premenovat 
o Threading – porušenie pravidiel práce s vláknami 
o Test – ku kódu je potrebné doplnit testy 
o Logging – chýbajúce/nevhodné zaznamenávanie udalostí 
o Recommendation – odporúcanie na zlepšenie 
o Configuration – konštanty by mali byt definované v konfiguracných súboroch 
o Logic – chyba v logike riešenia/algoritmu 
o Security – porušenie bezpecnostných pravidiel 
o API – nevhodné použitie knižnice, služby, ... 
o DataStructure – nevhodné použitie dátovej štruktúry 
o ErrorHandling – porucenie pravidiel spracovania výnimiek a chýb 
o Readability – zle citatelný kód. Napr. z dôvodu použitia príliš dlhých konštrukcií, 
nevhodného formátovania, ... 
o Style – všeobecné porušenie štýlu písania zdrojového kódu 
o Async – zlé spracovanie asynchrónnych udalostí 
o Scope – nevhodné použitie modifikátora prístupu 
o Perf – možný problém s výkonnostou 
?lCVE – typ zranitelnosti podla CVE (http://www.cvedetails.com). V prípade, že je známa konkrétna 
zranitelnost, môže byt jej identifikátor uvedený v atribúte CRV 
o DoS 
o CodeExecution 
o Overflow 
o MemoryCorruption 
o SqlInjection 
o XSS 
o DirectoryTraversal 
o HttpResponseSplitting 
o BypassSomething 
o GainInformation 
o GainPrivilegues 
o CSRF 
o FileInclusion 
REFACTOR 
Oznacenie kódu, ktorý vyžaduje refaktorovanie 
Atribúty: 
?SMetóda – metóda refaktorovania (podla: http://sourcemaking.com/refactoring), ktorá by mala 
byt použitá 
o Extract Method 
o …