На этом шаге мы рассмотрим это понятие.

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

Такой подход обеспечивает естественную основу для переключения между естественным языком (русским, английским и т.п.) и формальным языком (C, Lisp, ML, C# и т.п.) и их совмещения.

Литературное (грамотное) программирование (англ. Literate Programming - грамотное, культурное программирование) - это концепция, методология программирования и документирования программного кода.

Термин и саму концепцию разработал Д.Кнут (1981) при разработке системы компьютерной вёрстки T_EX. Он писал: "Давайте изменим традиционные приоритеты в создании программ: вместо представления о нашей задаче как о создании инструкций "Что делать?" для компьютера сконцентрируемся на объяснении другим людям описаний нашего видения того, что под управлением программы должен делать компьютер".

Для понимания литературного программирования вспомним объяснения в курсах программирования, написанные фразами на псевдокоде на "человеческом" языке. Они понятны, если код труден, и скрывают под одной фразой-"оператором" множество других вложенных абстракций и/или программного кода на непосредственно машинном языке.

Литературное программирование в некотором смысле - это "программирование на псевдокоде" с помощью произвольных фраз, которые затем раскрываются как макросы с помощью утилиты из исходного файла, который включает в себя одновременно документированные текстовые объяснения концепций, сам код и псевдокод.

Поговорим о сущности подхода.

Литературное программирование - это метаподход к написанию программ, т.е. парадигма, применимая к любой (процедурной, функциональной, декларативной, объектно-ориентированной) компьютерной программе на любом машинном языке.

Литературное программирование является системой макросов, создаваемая из фраз на естественном языке, которые превращаются в метаязык над конкретным языком программирования. Пользование этими фразами подобно объяснению алгоритмов на псевдокоде, но в случае литературного программирования они становятся точными "новыми операторами" метаязыка. При этом:

программа и документация более не пишутся как машинный код с примечаниями. Само конструирование программы идёт в порядке, определяемом логикой мысли (или объяснений), где макросы псевдокода играют роль абстракций (над кодом) для ясности мысли. Меняется кардинально порядок следования в программе, он не машинный, а тот, которого требует логика;
технически литературное программирование делается с помощью утилиты, которая одной командой запускает препроцессор, раскрывает все макросы и "запутывает" (англ. tangle) логическое изложение в машинный код, который потом можно компилировать или запускать как обычно. Другая команда "сплетает" (от англ. weave) из этого общего для программы и объяснений файла отформатированную документацию (для печати, Интернета и т.д.).

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

Литературное программирование используется в следующих случаях:

для выражения концепции записи текста программы, превращающей программу в аналог литературного произведения, в котором "литературно" записанные комментарии имеют определённый приоритет перед собственно программным кодом;
для фиксирования "потока сознания" программиста при организации программного кода: программист в определённом смысле разговаривает сам с собой; в результате, читая год спустя программу, записанную в литературном коде, можно понять, о чём думал автор в процессе её написания;
для эффективного ведения программной документации, обеспечивающей связи между группами программистов. Например, когда вы вводите некоторые тонкие детали в свою программу, литературное программирование показывает, что перед нами не просто код, выполняющий поставленные задачи, - это ещё и документация.
Вы говорите: "Здесь был использован запрещённый приём, он работает, потому что..." - и расписываете в мельчайших подробностях причины и основные положения;
для написания статей и книг: с одной стороны, такой код будет понятен трансляторам Haskell, а с другой - оформленные таким образом тексты можно сдавать в издательства для публикации.

Перечислим ряд ошибочных представлений о литературном программировании:

система литературного программирования мало распространена из-за непонимания: многие думают, что литературное программирование - это лишь система документирования или система форматирования обычных комментариев. На самом деле, программа практически без комментариев может быть написана с применением подхода литературного программирования, равно как и многословные примечания сами по себе не создают подхода литературного программирования;
самое частое непонимание относится к роли системы макросов, позволяющей строить произвольные системы абстракций над абстракциями и к изменению порядка следования кусков от машинно-ориентированного к тому, который требует мышление. Так, неверно считать литературным программированием использование систем документирования интерфейсов (JavaDoc, doxygen, DOC++, autoduck, POD).

Приведём инструменты литературного программирования:

WEB - система программирования для языка Паскаль;
CWEB - версия WEB, разработанная для документирования С, C++ и Java;
FWEB - система программирования для языка Fortran;
pyWeb - система, позволяющая создавать программы на любом языке программирования и описывать их с помощью произвольного языка разметки, например, HTML, LaTeX, reStructured Text;
Rambutan - система программирования для языка Java.

Замечание (важное). Литературное программирование не превращает сложную программу в простую - это лишь один из способов программирования.

На следующем шаге мы рассмотрим литературный код на языке Haskell.

Предыдущий шаг Содержание Следующий шаг