Re: [bcn-pm] Sistema de documentación

Xavier Noria fxnahashref.com
Div Oct 14 02:27:47 PDT 2005


On Oct 14, 2005, at 11:03, Carlos Escribano wrote:

> El Viernes 14 Octubre 2005 09:28, Xavier Noria escribió:
>
>> Yo lo use en una incursion a la programacion literaria que hice hace
>> un tiempo
>>
>
> Y cómo incluias en Halk el POD, o lo que sea en Ruby la  
> documentación externa,
> en tu puzzle de trocitos de código y documentación?

No se usa programacion literaria para generar documentacion perlosa,  
se usa programacion literaria para generar documentacion al estilo  
del paradigma, es decir con los chunks mezclados, referencias  
cruzadas por todas partes, ids en el codigo en cursiva, etc. Por ello  
el markup que uses en los chunks de documentacion no tiene por que  
ser el natural del lenguaje (POD, RDoc, Javadoc, ...), y en general  
no lo es.

Por ejemplo, para quienes no lo hayais visto nunca, un tipico  
documento litprog tiene esta pinta:

     http://www.eecs.harvard.edu/~nr/noweb/examples/wc.html

Esa es la documentacion de una implematacion de wc(1) en noweb en  
version HTML.

-- fxn


Més informació de la llista de correu Barcelona-pm