Шта су ХТМЛ коментари и како се користе
а Када прегледате веб страницу у прегледачу, видећете визуелну представу онога што тај део софтвера (веб прегледач) приказује на основу кода одређене веб странице. Ако погледате тај изворни код веб странице, видећете документ састављен од различитих ХТМЛ елемената, укључујући параграфе, наслове, листе, линкове, слике и још много тога. Сви ови елементи су приказани од стране прегледача на екрану посетиоца као део приказа веб странице. Једна ствар коју можете наћи у ХТМЛ коду који није приказан на екрану особе је оно што је познато као "ХТМЛ коментари".
Шта је коментар?
Коментар је низ кода унутар ХТМЛ-а, КСМЛ-а или ЦСС-а који прегледач или парсер не прегледају или не дјелују. Једноставно је уписано у шифру да би пружио информације о том коду или другим повратним информацијама од програмера кода.
Већина програмских језика има коментаре, најчешће их користи програмер кода за један или чак више од једног од следећег разлога:
- Опишите и објасните компликовани код некоме ко ће можда морати да ради на њему у будућности - укључујући и себе! Они се могу вратити на шифру 3 или 6 од 12 месеци или више касније и не сјећати се зашто су учинили нешто на одређени начин. Коментари могу помоћи да одговоре на њихова питања и подсећају на то где је њихов ум био када су први пут развили ту страницу.
- Наведите детаље о томе када је код уређен или прегледан. Ово може бити корисна информација и деловати донекле као евиденција развоја када је локација последње прошла.
- Уклоните секције кода, али оставите их доступним за каснију употребу. Ово се често врши током тестирања и дебаговања на локацији. Ако имате проблем на сајту и нисте сигурни шта то узрокује, можете да коментаришете одељке један по један за кварентин и идентификујете проблем, а затим радите на поправку за све проблеме које имате.
- Разговарајте са другим програмерима који раде на коду. Ово би се вероватно учинило током развоја како би се дијелили детаљи са другим особама које раде на коду у исто вријеме. Ако су ови коментари чисто развојни разговори, најбоља је пракса да их уклоните из кода пре него што се локација покрене.
Традиционално, коментари у ХТМЛ-у се користе за скоро све елементе, од објашњења сложених структура табеле до информативних напомена садржаја саме странице. Пошто се коментари не приказују у прегледачу, можете их додати било гдје у ХТМЛ-у и немате бриге о томе шта ће учинити када се страница прегледа од стране купца.
Како написати коментаре
Писање коментара у ХТМЛ, КСХТМЛ и КСМЛ је веома једноставно. Једноставно окружите текст који желите да коментаришете са следећим:
и ->Као што видите, ови коментари почињу са "мање од симбола", плус изузетак и два дирња. Коментар се завршава са још два дирса и "већим од: симбола. Између тих ликова можете написати шта год желите да саставите тело коментара.
У ЦСС-у, то је мало другачије, користећи коментаре Ц кода, а не ХТМЛ. Почињеш са сломом за праћењем а затим астериском. Завршите коментар са инверзном за то, астериском слиједи слијеп слом.
/ * коментарисао текст * /Коментари су умирућа уметност
Већина програмера зна вредност корисних коментара . Коментарисани код олакшава пренос тог кода са једног члана тима у други. Коментари вам помажу тиму КА да тестира шифру, јер они могу рећи шта је програмер наменио - чак и ако то није постигнуто. Нажалост, са популарношћу платформи за ауторизацију веба као што је Вордпресс, који вам омогућавају да устанете и покренете одабрану тему која обрађује много, ако не и све, ХТМЛ за вас, коментари се не користе често од стране веб тимова. То је зато што су коментари заиста тешко видети у већини визуелних алата за ауторизацију ако не радите директно са кодом. На пример, уместо да видите, на врху веб странице:
Визуелни алат показује малу икону која означава да постоји коментар. Ако дизајнер физички не отвори коментар, он то можда неће видети. А у случају горе наведене странице, може доћи до проблема ако измени страницу и да је уређивање преписано сценаријом наведеном у коментару.
Шта може да се уради?
- Напишите значајне и корисне коментаре. Немојте очекивати да други људи читају ваше коментаре ако су предуго или не садрже корисне информације.
- Као програмер, увек треба да прегледате све коментаре које видите на страници.
- Користите алате које су обезбедили програми за ауторизацију који вам омогућавају да додате коментаре.
- Користите управљање садржајем како бисте контролисали начин на који се странице уређују.
Чак и ако сте једина особа која уређује ваше веб странице, коментари могу бити корисни. Ако само једном уређујете компликовану страницу једном годишње, лако је заборавити како сте направили таблицу или спојили ЦСС. Са коментарима, не морате се запамтити, јер је то написано тачно за вас.
Оригинални чланак Јеннифер Кринин. Уредио Јереми Гирард 5/5/17