Сходство информационного стиля и программного кода | Way23

Сходство информационного стиля и программного кода

Правила информационного стиля из книги Пиши-сокращайopen in new window похожи на принципы написания хорошего кода. Источник сходства в единой основе кода, статей и книг — в тексте предназначенном в первую очередь для чтения.

Стоп-слова

Тексты в информационном стиле не содержат лишних словopen in new window. Редактор целенаправленно ищет и удаляет лишние слова и конструкции.

Существуют конструкции нежелательные на любом языке программирования, такие как сравнение с логической переменной и присвоение True и False:

if Value then
  Result := True
else
  Result := False;
1
2
3
4

Опытный разработчик заменяет такую конструкцию одной строкой:

Result := Value;
1

Структура

Писатель делит текст на абзацы. Абзацы структурируют текст. Структурированный текст проще читать.

Разработчики разделяют команды на логические блоки пустыми строками:

a = input()
b = input()

if a = b:
1
2
3
4

Для выделения уровня вложенности используют отступы:

if Field.IsNull then
  Field.Value := 1
else
  Field.Value := 2;
1
2
3
4

Модуль

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

Разработчик делит программу на функции и модули. Функциям и модулям даются информативные названия. Функции и модули имеют определённое назначение. Модули имеют высокую связность внутри и низкую снаружи — с другими модулями. Как модули так и функции подразумевают возможность повторного использования.

Последниее изменение: 05.04.2022, 16:01:34