Cita:
Empezado por Ñuño Martínez
En cuanto a la documentación, ¿has probado pasdoc? [...] |
Te soy sincero, Ñuño, no me convence la idea de usar
documentación automatizada, creo que eso reduciría la "estética" del código y dificultaría su manejo. Además, todos los comentarios que van en el código fuente los escribo en inglés, aunque a veces me lleva eternos minutos redactar unas cuantas líneas que le parezcan aceptables a quienes hablan ese idioma. Si bien puede ser difícil al principio, considero que lo anterior es algo que debería procurarse con cualquier biblioteca de programación de uso público: usar el idioma inglés tanto para el código fuente como para los comentarios que van en él.
En cambio para la documentación o "manual de referencia", como ya has notado, uso el castellano. No me considero capaz de escribir algo tan formal en el idioma de Mark Twain; ya llegarán —espero— varios samaritanos que comprendan el español leído, sean diestros en el inglés y aporten cinco o diez horas de su valiosa vida ayudando a traducir el manual.
Por otro lado, creo que utilizar el propio foro para la documentación ofrece varias ventajas, como es un adecuado formato de presentación, la disponibilidad pública en la Red y la
retroalimentación con los usuarios. De hecho me extraña que hasta el momento nadie más haya publicado alguna biblioteca en el
nuevo foro.
Saludos.
P.D. 334 visitas y sólo seis votantes...
31-07-2013
Temas Similares
Modo Hilado