[bcn-pm] Sistema de documentación

Carlos Escribano cesatablinum.org
Dij Oct 13 18:46:35 PDT 2005


Hace un par de años seguí de cerca el tema de la programación literaria y su 
aproximación desde XML, e incluso diseñé un sistema simple corriendo con perl 
para su uso en la web con cgi.

Ahora vuelvo a la carga, queriendo hacer algo más consistente, y a la vez más 
portable; la anterior versión dependía de XML::LibXML y ahora quiero un 
abanico de opciones mayor, incluido SAX. 

De todos modos me encallo en el mismo sitio, su incompatibilidad con POD. 
Puedo incluir el código dentro de un documento docbook, que hace de 
documentación interna, explicando qué hace el código, pero la documentación 
externa (el tradicional POD) queda fuera de este esquema. Hasta ahora siempre 
he pensado que se puede añadir al final, a manera de un anexo al documento 
principal.

Sin embargo, el enfoque que nos mostró Francesc en su charla sobre Test::More 
me agradó mucho, integrando la documentación externa con el propio código. El 
problema es que el tratamiento de Francesc estructura el código a través de 
bloques, los métodos o funciones del módulo, mientras que la programación 
literaria otorga más libertad en la estructura del código, pudiendo ser sus 
unidades mucho más pequeñas o mayores según nos interese comentar.

Y no, no me sirve Lip::Pod, porque le falta un elemento esencial de la 
programación literaria, el desorden: Lip::Pod preserva el orden del código 
Perl, lo que fuerza a describirlo exactamente igual que se muestra en el 
listado. Esto al margen de que no es una solución XML, que es lo que estoy 
explorando.   

¿Alguna idea al respecto?

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: signature
Url : http://mail.pm.org/pipermail/barcelona-pm/attachments/20051014/90818c14/attachment.bin


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