Грамотное программирование

Грамотное программирование (ГП; англ. Literate Programming) — концепция, методология программирования и документирования, в которой программа состоит из прозы на естественном языке вперемежку с макроподстановками и кодом на языках программирования^[1]. Термин и саму концепцию предложил Дональд Кнут в 1981 году при разработке системы компьютерной вёрстки ΤΕΧ.

Грамотное программирование подобно объяснениям на лекциях по программированию, использующим фразы на «псевдокоде» на естественном языке. Они вносят ясность в сложный код и скрывают под одной фразой множество других вложенных абстракций и программного кода на формальном языке программирования.

ГП в некотором смысле есть «программирование на псевдокоде» произвольными фразами, которые затем раскрываются как макросы с помощью утилиты из исходного файла, который включает в себя одновременно документированные текстовые объяснения концепций, сам код и псевдокод.

Сущность подходаПравить

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

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

Давайте изменим традиционные приоритеты в создании программ: вместо представления о нашей задаче как о создании инструкций «Что делать?» для компьютера сконцентрируемся на объяснении другим людям описаний нашего видения того, что под управлением программы должен делать компьютер.

— Дональд Кнут, http://community.livejournal.com/ru_perl/249441.html

ПринятиеПравить

Система ГП, которую Кнут предлагал как альтернативу «структурному программированию» 1970-х годов, несмотря на благоприятные отзывы, не получила широкого распространения из-за отсутствия инструментальной поддержки и их интеграции^[2].

Другой проблемой явилась ориентация ГП на пакетную обработку, тогда как системы программирования всё больше стали ориентироваться на средства с WYSIWYG^[2].

Кроме того, распространению ГП помешали ложные представления о том, что «грамотные программы» должны быть монолитными и что ГП — противоположность гипертекста^[2].

Многие полагают, что ГП — лишь система документирования или система форматирования обычных комментариев. На самом деле, программа практически без комментариев может быть написана с применением подхода ГП, равно как и многословные примечания сами по себе не создают ГП-подхода.

Самое частое непонимание относится к роли системы макросов, позволяющей строить произвольные системы абстракций над абстракциями и к изменению порядка следования кусков от машинно-ориентированного к тому, который требует мышление. Так, абсолютно неверно считать ГП-программированием использование систем документирования интерфейсов вроде JavaDoc, doxygen, DOC++, autoduck, POD.

Ещё одним заблуждением считается, что Д. Е. Кнут хотел зафиксировать подход «сверху вниз» в разработке программных систем. На самом деле он предлагает совмещать подходы «сверху вниз» и «снизу вверх», как это следует из цитаты, приведённой в книге TeX:The program: «But the author suggests that the best way to understand this program is to follow pretty much the order of TeX’s components as they appear in the WEB description you are now reading, since the present ordering is intended to combine the advantages of the „bottom up“ and „top down“ approaches to the problem of understanding a somewhat complicated system.»

Существующие инструментыПравить

WEB — система программирования для языка Паскаль
CWEB^ru_en — версия WEB, разработанная для документирования С, C++ и Java
FWEB^ru_en — система программирования для языка Фортран
pyWeb — система, позволяющая создавать программы на любом языке программирования и описывать их с помощью произвольного языка разметки, например, HTML, reStructured Text или LAΤΕΧ
Rambutan — система программирования для языка Java
Noweb^ru_en
FunnelWeb^ru_en
CLiP, cnoweb
simplelp (http://gitorious.org/simplelp (недоступная ссылка))

ПримечанияПравить

↑ Иногда методологию образно называют «литературным программированием»
↑ ¹ ² ³ Sametinger, 1997, 18. Literate programming.

ЛитератураПравить

Sametinger, J. Software Engineering with Reusable Components. — Springer, 1997. — 272 p. — ISBN 9783540626954.
Robinson, J.A. 2.4 Software as literature // Software Design for Engineers and Scientists. — Elsevier Science, 2004. — 414 p. — ISBN 9780080474403.

СсылкиПравить

[1] Иногда методологию образно называют «литературным программированием»

[_bd84562c2665da82-2] ¹ ² ³ Sametinger, 1997, 18. Literate programming.

[1]

[2]