Правилно коментираният HTML маркер е важна част от добре изградената уеб страница. Тези коментари са лесни за добавяне и всеки, който трябва да работи по този код в бъдеще (включително вие или членове на екипа, с който работите), ще ви благодари за тези коментари.
Как да добавяте HTML коментари
HTML може да бъде създаден със стандартен текстов редактор, като Notepad ++ за Windows или TextEdit за Ma. Можете да използвате и уеб дизайн-ориентирана програма като Adobe Dreamweaver или дори CMS платформа като Wordpress или ExpressionEngine. Независимо от инструмента, който използвате за създаване на HTML, ако работите директно с кода, бихте добавили HTML коментари по следния начин:
- Добавете първата част на маркера за HTML коментари:
- След това начало на коментара, напишете кой текст искате да се появи за този коментар. Това вероятно ще бъде инструкции за вашия или друг разработчик в бъдеще. Например, ако искате да определите къде даден участък на страница започва или завършва с маркирането, можете да използвате коментар, за да уточните това.
- Щом текстът на коментара ви бъде завършен, затворете коментара като този: ->
- Общо взето вашият коментар ще изглежда по следния начин:
Показване на коментарите
Всички коментари, които добавяте към HTML кода, ще се показват в този код, когато някой види източника на уеб страницата или отвори HTML в редактор, за да направи някои промени. Този текст на коментара обаче няма да се появи в уеб браузъра, когато обикновен посетител дойде на сайта. За разлика от други HTML елементи, включително параграфи, заглавия или списъци, които всъщност влияят на страницата в тези браузъри, коментарите наистина са "зад кулисите" на страницата.
Коментари за тестови цели
Тъй като коментарите не се показват в уеб браузър, те могат да бъдат използвани за "изключване" на части от страница по време на тестване или разработка на страници. Ако добавите частта за отваряне на коментар директно преди частта от страницата / кода, която искате да скриете, а след това добавите затварящата част в края на този код (коментарите в HTML могат да обхващат няколко реда, така че можете да отворите коментирайте кажете линия 50 на кода си и го затворете на линия 75 без проблеми), тогава какви HTML елементи, които попадат в този коментар, вече няма да се показват в браузъра. Те ще останат във вашия код, но няма да повлияят на визуалния дисплей на страницата. Ако трябва да тествате дадена страница, за да видите дали дадена секция причинява проблеми и т.н., коментирането на тази област е за предпочитане да я изтриете. С коментари, ако въпросната секция на кода се окаже, че не е проблемът, можете лесно да премахнете коментарите и този код ще се покаже още веднъж. Просто се уверете, че тези коментари, които се използват за тестване, не го правят в производствените сайтове.
Ако дадена област на страницата не трябва да се показва, искате да премахнете кода, а не просто да го коментирате, преди да стартирате този сайт.
Едно голямо използване на HTML коментари по време на разработката е, когато изграждате отзивчив уебсайт . Тъй като различните части на този сайт ще променят външния си вид въз основа на различни размери на екрана , включително някои области, които може да не се показват изобщо, използването на коментари за превключване на раздели на страница в или изключване може да бъде бърз и лесен трик за използване по време на разработката.
По отношение на ефективността
Виждал съм някои уеб специалисти да предполагат, че коментарите трябва да бъдат премахнати от HTML и CSS файлове, за да се обръсне размерът на тези файлове и да се създадат по-бързо зареждащи се страници. Макар че съм съгласен, че страниците трябва да бъдат оптимизирани за ефективност и да се зареждат бързо, все още има място за интелигентно използване на коментари в кода. Не забравяйте, че тези коментари са предназначени да улеснят работата в даден сайт в бъдеще, дотолкова, доколкото не го запълвате с коментари, добавени към всеки ред в кода ви, малкия размер на файла, добавен към страницата поради коментарите трябва да бъдат повече от приемливи.
Съвети за използване на коментари
Няколко неща, които трябва да имате предвид или да помните, когато използвате HTML коментари:
- Коментарите могат да бъдат няколко реда.
- Използвайте коментари, за да документирате развитието на страницата си.
- Коментарите могат да се добавят; така че съдържанието на документа, редове или колони в таблицата, проследяване на промените или каквото искате.
- Коментарите, които "изключват" зоните на даден сайт, не трябва да се правят в производство, освен ако тази промяна не е временна, която ще бъде обърната в кратки срокове (например, ако е необходимо, да се включи или изключи предупредително съобщение).