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