Literate programming: differenze tra le versioni

Versione delle 12:02, 30 mag 2022

Versione attuale delle 18:40, 20 nov 2024

(8 versioni intermedie di 6 utenti non mostrate)

Riga 3:

Il paradigma del literate programming, come concepito da Knuth, rappresenta un allontanamento dalla scrittura di programmi per computer nel modo e nell'ordine imposti dal computer, e consente invece ai [[Programmatore informatico|programmatori]] di sviluppare programmi nell'ordine richiesto dalla logica e dal flusso dei loro pensieri.<ref>{{Cita|Knuth}}{{Citazione|I had the feeling that top-down and bottom-up were opposing methodologies: one more suitable for program exposition and the other more suitable for program creation. But after gaining experience with WEB, I have come to realize that there is no need to choose once and for all between top-down and bottom-up, because a program is best thought of as a web instead of a tree. A hierarchical structure is present, but the most important thing about a program is its structural relationships. A complex piece of software consists of simple parts and simple relations between those parts; the programmer's task is to state those parts and those relationships, in whatever order is best for human comprehension not in some rigidly determined order like top-down or bottom-up}}</ref> I literate programs sono scritti come un'esposizione ininterrotta della logica in un linguaggio umano ordinario, proprio come il testo di un [[saggio]], in cui sono incluse le macro per nascondere le astrazioni e il [[codice sorgente]] tradizionale.

Gli strumenti per il literate programming (LP) vengono utilizzati per ottenere due rappresentazioni da un [[file sorgente]] literate: uno adatto per ulteriori compilazioni o [[File eseguibile|esecuzioni]] da un computer, il codice "aggrovigliato" o "tangled" e un altro per la visualizzazione come documentazione formattata, che si dice sia "intessuta" o "woven".<ref name="ObliqueScottReference">Se si ricorda ch la prima versione dello strumento era chiamata WEB, l'interessante riferimento letterario nascosto da Knuth in questi nomi diventa ovvio:{{Citazione|Oh, what a tangled web we weave when first we practise to deceive|autore=[[Sir Walter Scott]], in Canto VI, Stanza 17 di ''[[Marmion (poema)|Marmion]]'' (1808), un poema epico sulla [[battaglia di Flodden Field]] del 1513.}} La citazione reale apparve come un'epigrafe all'interno di un articolo pubblicato nel maggio del 1986 da Jon Bentley e Donald Knuth in una colonna di ''Programming Pearls'', presente in ''Communications of the ACM'', vol. 29, n. 5, p.365.</ref> Mentre la prima generazione di strumenti di literate programming era specifica per un certo linguaggio di programmazione, i successivi sono indipendenti ed esistono al di sopra di questi.

== Storia e filosofia ==

Riga 9:

== Concetto ==

Il literate programming consiste nello scrivere la logica del programma in un linguaggio umano con frammenti di codice e macro inclusi (separati da un markup primitivo). Le macro in un file sorgente literate sono semplicemente frasi simili a titoli o esplicative in un linguaggio umano, che descrivono le astrazioni umane create risolvendo il problema di programmazione, e nascondendo blocchi di codice o macro di livello inferiore. Queste macro sono simili agli algoritmi in [[pseudocodice]] tipicamente utilizzati nell'insegnamento dell'[[informatica]]. Queste frasi esplicative arbitrarie diventano precisi nuovi operatori, creati al volo dal programmatore, formando un ''meta-linguaggiometalinguaggio'' in cima al linguaggio di programmazione sottostante.

Un [[preprocessore]] viene utilizzato per sostituire gerarchie arbitrarie, o piuttosto "reti" di macro "interconnesse,<ref>{{Cita|Knuth}}{{Citazione|WEB's macros are allowed to have at most one parameter. Again, I did this in the interests of simplicity, because I noticed that most applications of multiple parameters could in fact be reduced to the one-parameter case. For example, suppose that you want to define something like... In other words, the name of one macro can usefully be a parameter to another macro. This particular trick makes it possible to...}}</ref> per produrre il codice sorgente compilabile con un comando ("tangle" o "groviglio") e la documentazione con un altro ("weave" o "trama"). Il preprocessore offre anche la possibilità di generare il contenuto delle macro e di aggiungere le macro già create in qualsiasi posizione nel testo del file sorgente del programma, eliminando così la necessità di tenere presente le restrizioni imposte dai [[Linguaggio di programmazione|linguaggi di programmazione]] tradizionali o di interrompere il flusso del pensiero.

=== Vantaggi ===

Secondo Knuth, il literate programming<ref name="Knuth">{{Cita web|url=https://www.informit.com/articles/article.aspx?p=1193856|titolo=Interview with Donald Knuth|data=25 aprile 2008|citazione=Yet to me, literate programming is certainly the most important thing that came out of the [[TeX]] project. Not only has it enabled me to write and maintain programs faster and more reliably than ever before, and been one of my greatest sources of joy since the 1980s-it has actually been indispensable at times. Some of my major programs, such as the MMIX meta-simulator, could not have been written with any other methodology that I've ever heard of. The complexity was simply too daunting for my limited brain to handle; without literate programming, the whole enterprise would have flopped miserably.... Literate programming is what you need to rise above the ordinary level of achievement.|accesso=4 gennaio 2009}}</ref><ref>{{Cita|Knuth}}. {{Citazione|Another surprising thing that I learned while using WEB was that traditional programming languages had been causing me to write inferior programs, although I hadn't realized what I was doing. My original idea was that WEB would be merely a tool for documentation, but I actually found that my WEB programs were better than the programs I had been writing in other languages.}}</ref> fornisce programmi di qualità superiore, poiché obbliga i programmatori a dichiarare esplicitamente i pensieri alla base del programma, rendendo più ovvie le decisioni di progettazione scarsamente ponderate. Knuth afferma anche che il literate programming fornisce un sistema di documentazione di prim'ordine, che non è un componente aggiuntivo, ma è "cresciuto" naturalmente nel processo di esposizione dei propri pensieri durante la creazione di un programma.<ref>{{Cita|Knuth}}. {{Citazione|Thus the WEB language allows a person to express programs in a ''"stream of consciousness" order''. TANGLE is able to scramble everything up into the arrangement that a PASCAL compiler demands. This feature of WEB is perhaps its greatest asset; it makes a WEB-written program much more readable than the same program written purely in PASCAL, even if the latter program is well commented. And the fact that there's no need to be hung up on the question of top-down versus bottom-up, since a programmer can now ''view a large program as a web, to be explored in a '''psychologically correct order''' is perhaps the greatest lesson'' I have learned from my recent experiences.}}</ref> La documentazione risultante consente all'autore di riavviare i propri processi di pensiero in qualsiasi momento successivo, e consente ad altri programmatori di comprendere più facilmente la costruzione del programma. Ciò differisce dalla documentazione tradizionale, in cui a un programmatore viene presentato un codice sorgente che segue un ordine imposto dal compilatore e da cui deve decifrare il processo di pensiero dietro il programma dal codice e dai commenti associati. Le capacità meta-linguistichemetalinguistiche del literate programming si sostiene anche che facilitino il ragionamento, offrendo una "visione a volo d'uccello" del codice e aumentando il numero di concetti che la mente può conservare ed elaborare con successo. L'applicabilità del concetto alla programmazione su larga scala, quella dei programmi di livello commerciale, è dimostrata da una edizione del codice [[TeX]] come literate program.<ref name="Knuth" />

Knuth afferma inoltre che il Literate Programming può portare ad un facile [[porting]] di un dato software su più ambienti, e cita persino l'implementazione di TeX come esempio.<ref>{{Cita web|url=http://archive.computerhistory.org/resources/text/Oral_History/Knuth_Don_1/Knuth_Don.oral_history.2007.102658053_all.pdf|titolo="Oral History of Donald Knuth"- an Interview with Ed Feigenbaum|sito=archive.computerhistory.org|accesso=7 dicembre 2018|lingua=en}}</ref>

=== Contrasto con il classico processo di generazione della documentazione ===

Riga 28:

{{Citazione|Knuth ci ha mostrato come programmare intellegibilmente, ma non saggiamente. Apprezzo la disciplina. Non apprezzo il risultato. Ha creato una sorta di intricato uovo Faberge di qualità industriale, magnificamente lavorato, rifinito oltre ogni ordinario desiderio, un autentico pezzo da museo.}}

McIlroy ha successivamente ammesso che la sua critica era ingiusta, dal momento che ha criticato il programma di Knuth su basi ingegneristiche, mentre lo scopo di Knuth era solo quello di dimostrare la tecnica del literate programming.<ref>{{Cita web|url=https://www.princeton.edu/~hos/mike/transcripts/mcilroy.htm|titolo=Interview with M. D. McIlroy|autore=Michael Sean Mahoney|data=18 agosto 1989|lingua=en}}</ref> Nel 1987, ''[[Communications of the ACM]]'' ha pubblicato un articolo di follow-up che illustrava il literate programming con un programma C che combinava l'approccio artistico di Knuth con l'approccio ingegneristico di McIlroy, con una critica di John Gilbert.<ref>{{Cita pubblicazione|autore=Christopher J. Van Wyk|data=luglio 1987|titolo=Literate programming|volume=30|numero=7|pp=593-599|url=https://www.cs.upc.edu/~eipec/pdf/p583-van_wyk.pdf|autore2=David R. Hanson|autore3=John Gilbert|lingua=en|accesso=30 luglio 2019|dataarchivio=16 luglio 2023|urlarchivio=https://web.archive.org/web/20230716224057/https://www.cs.upc.edu/~eipec/pdf/p583-van_wyk.pdf|urlmorto=sì}}</ref>

== Flusso di lavoro ==

Riga 62:

@

</syntaxhighlight>

Il dipanarsi dei blocchi può essere eseguito in qualsiasi posizione nel [[file di testo]] del programma letterato, non necessariamente nell'ordine in cui sono sequenziati nel blocco racchiudente, ma come richiesto dalla logica riflessa nel testo esplicativo che avvolge l'intero programma.

=== Programma come Web: le macro non sono solo nomi di sezioni ===

Riga 117:

Esistono varie altre implementazioni del concetto di programmazione letterata (alcune non hanno macro e quindi violano il principio dell'ordine della logica umana come punto prioritario):

* [[Axiom (software)|Axiom]], che si è evoluto da scratchpad, un sistema di calcolo algebrico per computer sviluppato da [[IBM]]. Ora è sviluppato da Tim Daly, uno degli sviluppatori di scratchpad, Axiom è totalmente scritto come literate program.

* noweb è indipendente dal linguaggio di programmazione del codice sorgente. È noto per la sua semplicità, data la necessità di utilizzare solo due convenzioni di markup del testo e due invocazioni di strumenti e consente la [[formattazione del testo]] in HTML anziché passare attraverso il sistema TeX.

* ''Literate'' è un "moderno sistema di literate programming". Come noweb, funziona con qualsiasi linguaggio di programmazione, ma produce HTML con evidenziazione della sintassi e cerca di conservare tutti i vantaggi di CWEB, incluso l'output formattato come CWEB. Altri notevoli vantaggi rispetto agli strumenti precedenti includono l'essere basato su Markdown e la generazione di codice "aggrovigliato" ben formattato.<ref>{{Cita web|autore=Zachary Yedidia|data=24 luglio 2019|titolo=A literate programming tool for any language|lingua=en|accesso=30 luglio 2019|sito=GitHub|url=https://github.com/zyedidia/Literate}}</ref>

* FunnelWeb è un altro strumento LP in grado di produrre output HTML. Ha un markup più complicato (con "@" che sfugge a qualsiasi comando FunnelWeb), ma ha molte opzioni flessibili. Come noweb, è indipendente dal linguaggio di programmazione del codice sorgente.<ref>{{Cita web|url=http://www.ross.net/funnelweb/|urlmorto=sì|urlarchivio=https://web.archive.org/web/20190604103010/http://www.ross.net/funnelweb/|sito=FunnelWeb|titolo=The FunnelWeb Literate Programming Tool|lingua=en}}</ref>

Riga 125:

* Molly è uno strumento LP scritto in [[Perl]], che mira a modernizzare e ridimensionare il literate programming per mezzo di "HTML pieghevole (folding)" e "viste virtuali" sul codice. Utilizza il markup "noweb" per i file di origine literate.<ref>{{Cita web|data=13 febbraio 2019|titolo=A literate programming "weaver" which can run as CGI to produce folding HTML-formatted documentation and runs with "noweb" tools of Norman Ramsey: unixtechie/Literate-Molly|sito=GitHub|lingua=en|accesso=30 luglio 2019|url=https://github.com/unixtechie/Literate-Molly}}</ref>

* Codnar è uno strumento di literate programming inverso disponibile come [[RubyGems|Ruby Gem]]. Invece di estrarre il codice sorgente leggibile dal compilatore dalle fonti di documentazione, la documentazione literate viene estratta dai normali file di codice sorgente leggibili dalla macchina. Questo consente a questi file di codice sorgente di essere modificati e mantenuti come al solito. L'approccio è simile a quello utilizzato dai più diffusi strumenti di documentazione [[Application programming interface|API]], come [[Javadoc|JavaDoc]]. Tali strumenti, tuttavia, generano documentazione di riferimento API, mentre Codnar genera una narrazione lineare che descrive il codice, simile a quella creata dai classici strumenti LP. Codnar può coesistere con gli strumenti di documentazione API, consentendo sia un manuale di riferimento che una narrazione lineare generabili dallo stesso set di file di codice sorgente.<ref>{{Cita web|autore=Oren Ben-Kiki|data=21 giugno 2019|sito=GitHub|titolo=Code Narrator: an inverse literate programming tool. - orenbenkiki/codnar|lingua=en|accesso=30 luglio 2019|url=https://github.com/orenbenkiki/codnar}}</ref>

* L'editor di testo Leo è un outlining editor che supporta opzionalmente i markup noweb e CWEB L'autore di Leo mescola due approcci diversi: in primo luogo, Leo è un outlining editor, cosa che aiuta nella gestione di testi di grandi dimensioni; in secondo luogo, Leo incorpora alcune delle idee del literate programming, che nella sua forma pura (cioè il modo in cui viene utilizzato dallo strumento Web di Knuth o strumenti come "noweb") è possibile solo con un certo grado di inventiva e l'uso dell'editor in un modo non esattamente previsto dal suo autore (in nodi @root modificati). Tuttavia, questa e altre estensioni (nodi @file) rendono la programmazione della struttura e la gestione del testo efficaci e facilmente gestibili ed in qualche modo simili al literate programming.<ref>{{Cita web|url=http://leoeditor.com/|titolo=Leo's Home Page|autore=Edward K. Ream|lingua=en|data=2 settembre 2008|accesso=3 aprile 2015|dataarchivio=16 luglio 2023|urlarchivio=https://web.archive.org/web/20230716224054/http://leoeditor.com/|urlmorto=sì}}</ref>

* Il [[Haskell (linguaggio)|linguaggio di]] programmazione [[Haskell (linguaggio)|Haskell]] ha il supporto nativo per un semi-literate programming. Il compilatore/interprete supporta due estensioni di file: <code>.hs</code> e <code>.lhs</code> ; quest'ultimo sta per literate Haskell.

Riga 166:

* [[Julia (linguaggio di programmazione)]] supporta la modalità di sviluppo iJulia che è stata ispirata da iPython.

* Agda (linguaggio di programmazione) supporta una forma limitata di literate programming pronta all'uso.<ref>{{Cita web|url=http://wiki.portal.chalmers.se/agda/pmwiki.php?n=Main.LiterateAgda|titolo=Literate Agda|sito=Agda Wiki|lingua=en|accesso=26 marzo 2017}}</ref>

* [http://witheve.com I programmi nel linguaggio di programmazione Eve] sono principalmente in prosa.<ref>{{Cita web|url=http://docs.witheve.com/handbook/literate-programming/|lingua=en|titolo=Eve and Literate ProgammingProgramming|sito=Eve Handbook|accesso=25 maggio 2017|urlarchivio=https://web.archive.org/web/20170524092539/http://docs.witheve.com/handbook/literate-programming/|dataarchivio=24 maggio 2017|urlmorto=sì}}</ref> Eve combina varianti di [[Datalog]] e [[Markdown]] con un ambiente di sviluppo grafico live.

* Simile ai quaderni Jupyter, i quaderni [https://bookdown.org/yihui/rmarkdown/notebook.html R] sono un metodo di literate programming che consente l'interazione diretta con [[R (software)|R]] (anche il supporto per Python, SQL e Bash sono esplicitamente menzionati) generando un documento riproducibile con output di qualità da pubblicazione.

* Il meccanismo di personalizzazione della [[Text Encoding Initiative]] che consente il vincolo, la modifica o l'estensione dello schema [[Text Encoding Initiative|TEI]] consente agli utenti di mescolare la documentazione in prosa con frammenti delle specifiche dello schema nel loro formato [[Text Encoding Initiative|One Document Does-it-all]]. Da questa documentazione in prosa, è possibile generare schemi e processi di elaborazione del modello e il paradigma del literate programming di Knuth viene citato come fonte d'ispirazione per questo metodologia di lavoro.<ref>{{Cita web|url=http://www.tei-c.org/release/doc/tei-p5-doc/en/html/USE.html#IMGD|titolo=TEI Guidelines|sito=TEI Consortium|lingua=en|accesso=23 agosto 2018|urlarchivio=https://web.archive.org/web/20180822123639/http://www.tei-c.org/release/doc/tei-p5-doc/en/html/USE.html#IMGD|dataarchivio=22 agosto 2018|urlmorto=sì}}</ref>

Riga 175:

== Bibliografia ==

* {{Cita pubblicazione|autore=Donald E. Knuth|anno=1984|titolo=Literate Programming|rivista=The Computer Journal|editore=British Computer Society|volume=27|numero=2|pp=97-111|accesso=4 gennaio 2009|doi=10.1093/comjnl/27.2.97|url=http://www.literateprogramming.com/knuthweb.pdf|cid=Knuth}}

* {{cita news|autore=Wayne Sewell|titolo=Weaving a Program: Literate Programming in WEB|url=https://archive.org/details/weavingprogramli0000sewe|pubblicazione=Van Nostrand Reinhold|anno=1989|isbn=0-442-31946-0 }}

* {{cita libro|autore=Donald Knuth|titolo=Literate Programming|anno=1992|editore=Stanford University - Center for the Study of Language and Information|isbn=978-0-937073-80-3}}

* {{cita libro|autore=Eitan M. Guari|titolo=TeX & LaTeX: Drawing and Literate Programming|editore=McGraw Hill|anno=1994|isbn=0-07-911616-7 }} (include software)