Ако сте заинтересовани за додавање референтних коментара на свој КСМЛ код, користите овај детаљни водич за смернице. Можете да научите како да извршите ову функцију за само пет минута. Иако је поступак лако довршити, ипак бисте требали знати неке основе о КСМЛ коментарима и њиховој корисности пре него што започнете.
Зашто су КСМЛ коментари корисни
Коментари у КСМЛ-у су готово идентични коментарима у ХТМЛ-у, јер обојица имају исту синтаксу. Коришћење коментара омогућава вам разумевање кода који сте написали годинама раније. Такође може помоћи другом програмеру који прегледава код који сте развили да разуме шта сте написали. Укратко, ови коментари пружају контекст кода.
Уз коментаре можете лако да оставите белешку или привремено уклоните део КСМЛ кода. Иако је КСМЛ дизајниран да буде „самоописни податак“, повремено ћете можда морати да оставите КСМЛ коментар.
Почетак
Ознаке коментара састоје се из два дела: дела који започиње коментар и дела који га завршава. За почетак додајте први део ознаке коментара:
Затим напишите било који коментар који желите. Пазите да коментаре не угнездите у друге коментаре (погледајте савете за више детаља). После тога ћете затворити ознаку коментара:
-->
Корисни савети
Када додајете референтне коментаре у свој КСМЛ код, имајте на уму да они не могу бити на самом врху вашег документа. У КСМЛ-у само КСМЛ декларација може бити на првом месту:
Као што је горе поменуто, коментари се не смеју угнездити један у други. Морате затворити свој први коментар пре него што отворите други. Такође, коментари не могу да се јављају унутар ознака, нпр.
.
Никада немојте користити две цртице (-) било где, осим на почетку и на крају коментара. Све у коментарима је ефективно невидљиво за КСМЛ парсер, зато будите веома опрезни да оно што остане и даље буде ваљано и добро обликовано.
Окончање
Ако и даље имате питања о додавању референтних коментара у КСМЛ код, можда ћете желети да прочитате књигу како бисте добили детаљну слику о томе како поступак функционише. Књиге као"Референце програмера Ц # 5.0", Род Степхенс може се показати корисним.