
Стиль программирования
Следование приведенным ниже правилам, доставляет мне большое
удовольствие. Мои коды легко читаются, отлаживаются и редактируются в
обычном текстовом редакторе.
-
Лесенка. В основе нотации лежит традиционное правило лесенки.
Лесенка (ступенчатые отступы) отражает вложенность команд друг в друга
и позволяет легко видеть в тексте границы больших многостроковых
конструкций.
-
Выделение скелета. HTML-теги как скелет
пронизывают информационные блоки, предназначенные для вывода на экран.
Для выделения тегового каркаса предлагается записывать названия команд
заглавными буквами. Эта рекомендация основана на разумном
предположении о мелкосимвольности информационных блоков.
Вместе с тем, предлагается записывать заглавными буквами только
названия команд, а имена атрибутов и их значения малыми.
Чтобы не переборщить. Ведь выделить много значит, не
выделить ничего.
-
Упирание коленок в стену. Информационный блок размещается с
первой позиции, а после него оставляется пустая строка. Это правило
особенно полезно для текстовых абзацев, ведь создавать и редактировать
текст гораздо удобнее, когда он начинается с левого края экрана.
Пустая строка после абзаца позволяет выполнять автоматическое
переформатирование текста в текстовом редакторе без
поломки скелетных тегов.
-
Короткие строки. HTML-код не должен иметь строк,
выходящих за границу экрана текстового редактора. Видеть всю строку на
экране большое удовольствие, а горизонтальная линейка
протяжки, наоборот, доводит до белого каления. Стараюсь не делать
строки длиннее 70 символов.
-
Умеренность комментариев. Комментарии в HTML не играют такой
существенной роли, как в настоящих языках
программирования. Самое лучшее применение для них
использование для временного выключения из работы
каких-либо элементов HTML-кода (для отладки
или временной консервации).
Пример 1: список
<UL type=disc>
<LI>Обложка (оглавление) сайта
<UL type=disc>
<LI>работы Сидорова
<LI>советы Сидорова
<LI>библиотека ссылок Сидорова
</UL>
</UL>
Пример 2: абзац
<HTML>
<HEAD>
...
</HEAD>
<BODY ...>
<H2>Название сайта</H2>
<P>
Как назовешь, так и заживешь! Не зря так говорят.
Пожалуй, самое сложное в создании сайта —
это его название.
<P>
Можно, конечно, обойтись и вовсе без названия,
вынеся в заголовок <EM>Сайт школы такой-то</EM>.
Однако, эту надпись лучше оставить для скобок. А
назвать так, чтобы название запоминалось, вызывало
желание полистать произведение.
...
</BODY>
</HTML>
Иван Сидоров
kurs@robotland.botik.ru