Почему важен вид кода программыНа этой странице:
Почему важен вид кода программыДо сих пор разговор шёл о том, как страница должна выглядеть на экране пользователя. Это, конечно, очень важно. Но не менее важную роль в непростом труде программиста играет внешний вид самой программы.
Записывать программу нужно так, чтобы смысл её конструкций был максимально понятен. Для такой рекомендации есть ряд веских причин.
Ясно написанную программу легче отлаживать, т. е. проводить обычный цикл опытов “посмотрел результат в браузере — подправил программу в текстовом редакторе”. Ведь в понятно написанном коде легче найти соответствие экранного изображения командам, которые это изображение строят.
Понятную программу легче сопровождать, т. е. вносить в неё изменения по прошествии какого-то времени. Программисты по собственному опыту знают, что через месяц после написания программы автор начисто забывает, где, что и зачем он писал в её исходном коде. Также всегда есть вероятность, что вашу программу будет модифицировать кто-то другой.
Пользователь, просматривая документ, всегда может заглянуть на вашу программистскую кухню. Для этого достаточно щелкнуть позицию Показать в виде HTML в меню Вид браузера. И всё то, что вы считали интимным, откроется его любопытствующему взору. Понятно, что о вас как о программисте сложится соответствующее мнение.
Наконец, известно, что летают только красивые самолёты. Хорошо работают только внятно написанные программы, внешний вид которых вызывает чувство эстетического удовольствия.
Программу, отображающий документ, можно записать и так:
По этому коду браузер изобразит документ точно так же, как и при структурной разметке. Ему абсолютно всё равно! Но нам-то — нет! Не стал бы я работать с таким кодом: искать в нём ошибки, вносить правки.
Нет, надо раз и навсегда усвоить, что программы пишутся не для компьютера, а для человека. Поэтому и оформлять их надо по-человечески.
Как записывать текст программыДля записи текста программы на HTML рекомендуется применять описанный ниже стиль. Этот стиль не является общепринятым на 100%, автор ввёл его по следующим соображениям.
Фиксирование правил записи. Лучше какой-то стиль, чем кавардак в программном коде. Вы можете принять мою нотацию как разумную, можете модифицировать её по своему усмотрению, можете заменить своей собственной. Главное — не отказываться от какой-то нотации вовсе. Определите и зафиксируйте для себя правила записи программ, следуйте им сами и требуйте соблюдения введённых правил от своих учеников.
Лесенка. В основе нотации лежит традиционное правило лесенки. Лесенка (ступенчатые отступы) отражает вложенность элементов друг в друга и позволяет легко увидеть в тексте границы больших многострочных конструкций.
“Упирание коленок в стену”. Рекомендуется применять правило лесенки при записи тегов блочных элементов, а строчные элементы, входящие в состав блочных, записывать с первой позиции так, как это удобно для их редактирования.
Выделение скелета. HTML-теги, как скелет, пронизывают информационные блоки, предназначенные для вывода на экран. Для выделения тегового каркаса предлагается записывать названия тегов заглавными буквами (синтаксис HTML позволяет записывать имена тегов, атрибутов и их значений в любом регистре).
Эта рекомендация основана на разумном предположении о “мелкосимвольности” информационных блоков. Вместе с тем, предлагается записывать заглавными буквами только названия тегов, а имена атрибутов и их значения — малыми. Чтобы не переборщить. Ведь выделить много — значит, не выделить ничего.
Короткие строки. Не записывайте HTML-программы со слишком длинными строками. Для их просмотра приходится применять горизонтальную прокрутку, а это неудобно. Любая строка должна целиком помещаться на экране текстового редактора (конкретная рекомендация: длина строки не должна превышать 80 символов).
Если вы работаете в редакторе Блокнот, то не пользуйтесь режимом Перенос по словам: Блокнот показывает на экране короткие строчки, а в файл записывает длинные. “Обман” легко обнаруживается после загрузки файла в другой редактор.
Запрет на табуляцию. Никогда не пользуйтесь табуляцией (клавишей Tab). Значение табуляции в редакторе настраивается и на 2 пробела, и на 4, и на 8. Структурная лесенка, построенная на табуляциях, зависит от этих настроек, и будет разрушена при их изменении. Например, вы передаете свой код на проверку другому человеку, а он не видит вашей лесенки, так как у него другие настройки для Tab.
Умеренность комментариев. Комментарием в HTML считается конструкция <!--...-->. Все, что располагается внутри этой структуры (на месте, обозначенном многоточием), браузер игнорирует.
Комментарии в HTML не играют такой существенной роли, как в “настоящих” языках программирования. Самое лучшее применение для них — обозначение в коде блоков, связанных с макетом вёрстки (“заголовочная часть”, “левая колонка”, “правая колонка”, “подвал”…), а также временное выключение из работы каких-либо элементов HTML-кода (для отладки или “консервации”).
Внутри комментария не должно быть двух или более смежных дефисов.
<!------ Так записывать комментарий нельзя ----> <!-- - - А так можно - - - - - - - - - - - - -->
Таким образом, теги самого первого элемента программы — <HTML>...</HTML> записываются с первой позиции строки. Все остальные элементы находятся внутри этого контейнера. Поэтому их запись должна быть смещена на две позиции вправо:
Теги внутри элементов <HEAD>...</HEAD> и <BODY>...</BODY> смещаются на две позиции вправо по отношению к началу записи элемента. Смещение продолжается и дальше для блочных элементов с соблюдением правила вложенности.
Все рассмотренные примеры программ выдержаны в описанном стиле.
Имена файлов и папокОтдельная рекомендация о правилах записи имён файлов и папок гипертекстового проекта.
Большинство серверов Сети работает под управлением операционной системы Unix или Linux. В этих системах регистр букв имеет значение.
Если путь к файлу с картинкой в теге IMG имеет вид "./pic/pic.gif", а реальный путь к файлу на диске — "./Pic/pic.gif", то под управлением ОС Windows ссылка будет работать. А вот если перенести сайт на сервер, работающий под управлением ОС Unix, пользователь картинку не увидит.
Это же относится и к указанию путей к любым другим файлам, которые браузер использует для отображения документа (гипертекстовые переходы, флэш-объекты, музыкальные файлы, файлы со скриптами и таблицами стилей).
Чтобы не было проблем с именами файлов и каталогов, используйте следующие рекомендации.
Все имена файлов и каталогов записывайте в формате 8.3 — не больше восьми символов в имени, не больше трёх — в расширении.
Не используйте русские буквы, пробелы и спецсимволы.
Все имена каталогов и файлов (htm, gif, jpg, txt, js, css и др.) записывайте в одном регистре (например, нижнем).
