Опубликован: 23.10.2005 | Доступ: свободный | Студентов: 3866 / 141 | Оценка: 4.44 / 4.19 | Длительность: 33:04:00
Специальности: Программист
Лекция 8:

Чувство стиля

Шрифты

При наборе программных текстов рекомендуются следующие соглашения, используемые в этой книге и связанных публикациях.

Основные правила

Используйте для программных элементов (имен классов, компонентов, сущностей и так далее) курсив. Это облегчает их включение в предложения обычного текста, как, например, "Можно видеть, что компонент number является запросом, а не атрибутом". (Слово number означает имя компонента, и вы не хотите, чтобы читатель мог подумать, что речь идет о числе компонентов!)

Ключевые слова, такие как class, feature, invariant и другие, набираются полужирным шрифтом ( boldface ).

Ключевые слова играют чисто синтаксическую роль: они не имеют собственной семантики. Как отмечалось ранее, есть несколько зарезервированных слов, не являющихся ключевыми, таких как Current и Result, обладающих семантикой выражений или сущностей. Они пишутся курсивом с начальным символом в верхнем регистре.

Следуя традициям математики, разделители - двоеточия, запятые, различные скобки и другие - всегда появляются прямыми (шрифтом roman), даже если они стоят после курсива1Это правило не всегда выдерживается в русском издании книги.. Подобно ключевым словам, они являются чисто синтаксическими элементами.

Текст комментария пишется прямым (roman) шрифтом. Имена программных элементов, в соответствии с ранее введенным правилом, даются в комментариях, курсивом. Например:

accelerate (s: SPEED; t: REAL) is
        -- Развить скорость s за максимум t секунд
...
set_number (n: INTEGER) is
        -- Сделать n новым значением number
...

В самих программных текстах, где невозможны вариации шрифта, такие вхождения формальных элементов в комментарии должны следовать соглашениям, уже упоминавшимся ранее: они появляются в одинарных кавычках

-- Сделать 'n' новым значением 'number'

(Заметьте, следует использовать разные символы для открывающей и закрывающей кавычки.) Инструментальные средства, обрабатывающие текст класса, такие как short и flat, знают об этом соглашении и при печати выводят закавыченные элементы курсивом.

Другие соглашения

Предыдущие соглашения о шрифтах хорошо работают для книг, статей, Web-страниц. В некоторых контекстах могут применяться другие подходы. Так при показе слайдов через проектор элементы, записанные курсивом, иногда и полужирным курсивом, не всегда читаются на экране.

В таких случаях я использую следующие соглашения:

  • использую полужирный некурсивный шрифт для всего, что требует лучшего проектирования;
  • выбираю достаточно широкий шрифт, такой как Bookman;
  • вместо курсива использую цвет для распознавания различных элементов.

Цвет

Все формальные элементы появляются в цвете2В русском издании книги в отличие от оригинала, к сожалению, применяется черно-белая печать..

Александр Качанов
Александр Качанов
Япония, Токио
Янош Орос
Янош Орос
Украина, Киев