Учебник HTML кода — миф о самодокументировании HTML — маркер комментария устраняет ошибку!
В кругах некоторых программистов популярным мифом является то, что хороший код — это та же документация. Черт, я видел тысячи строк совершенно неверного кода и HTML без единой строки комментариев. Спрашивая оригинального программиста, они часто говорят, что их код — самообслуживание. Этот миф использовался как предлог, чтобы не документировать HTML-код и код так много раз, что буквально меня тошнит.
Вот почему я хочу воспользоваться этой возможностью, чтобы взглянуть на этот миф. Тем не менее, позвольте мне ввести HTML-тег комментария, или, по крайней мере, вы не можете сказать, что вы не знаете, как он выглядит и что он делает.
Это действительно простой и удобный в использовании тег. Что еще более важно, информация, которую вы предоставляете между начальным и конечным тегами, может спасти вас и другого программиста, который много времени смотрит на ваш HTML!
Миф о кодексе самооценки
миф: Хороший код — это та же документация, которая не требует комментариев или других источников документации.
Демистификация мифа: В некоторой степени код очевиден. Предполагается, что если вы напишите хороший, элегантный HTML-код, вам будет легко увидеть, что вы делаете.
Возвращаясь к первым языкам программирования, на которых был изобретен синтаксис, было трудно прочитать то, что предполагалось. В настоящее время вы можете читать код самых популярных языков программирования, как если бы он был простым на английском языке. Это также относится к HTML. Хотя это не может быть прочитано, как если бы это был роман, довольно легко распознать, что делает каждый HTML-тег. Другими словами, кодирование является самообслуживанием.
Каждая прочитанная строка точно говорит о том, что она делает, и это побуждает более расслабленных (ленивых) программистов говорить, что нет необходимости активно документировать код.
Развенчивая миф: Я не видел HTML-файл исходного кода в Интернете, который содержит менее 100 строк. На самом деле, домашняя страница Google, которая представляет собой текстовое поле и 2 кнопки, содержит более 200 строк, если вы посмотрите на исходный код.
С таким количеством строк вам просто нужно как можно быстрее получить хороший обзор HTML-кода! Комментирование HTML — лучший способ сделать это!
Это правда, что вы можете видеть, что делает каждая строка HTML, но есть комментарии, которые помогут вам быстро понять, что делает вся страница HTML!
