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