Novacreations

Desarollando Software

BlueDoc

 Autor: Alejandro de León

Una gran parte de la aceptación que tenga un lenguaje de programación se debe a lo “amigable” que pueda ser para el usuario, en este caso, el programador. Java es un lenguaje que se caracteriza por ser independiente de la plataforma, estándar y con una amplia documentación, basada en el conocido API de Java.

Aparte de la documentación ya establecida en su API, SUN nos da la facilidad de crear nuestra propia documentación por medio de su javadoc, muy útil para compartir las aplicaciones escritas y vital para proyectos grandes. Por otra parte, aunque C++ también sea un lenguaje popular y bien establecido, no incluye ninguna utilidad ni estandarización para su documentación, lo que lo hace más difícil de compartir y analizar.

Al tener una forma común de escribir los comentarios, el lenguaje se vuelve mucho más amigable, puesto que no será necesario repasar línea tras línea de código buscando cuál es la función que necesitamos. De la misma manera, las personas con las cuales se comparten proyectos no necesitarán tener el código fuente, solo la parte precompilada y la documentación. Así se ayuda a mantener la encapsulación de los datos y al mismo tiempo, promueve la comprensión del trabajo realizado por otros.

Objetivos:

* Proponer una nueva forma de documentar en código C++, tomando como base el estándar del API de Java.
* Promover una forma estructurada de documentación, con vista a futuras aplicaciones y reciclado del código.

Ejecutables (Bin)
[download#60#info]
[download#61#info]

Fuente (Src)
[download#62#info]
[download#63#info]

Requerimientos
Microsoft .NET Framework Version 1.1 (Solo la versión en C# lo requiere)

Documentación

[download#66]
[download#67]
[download#64]
[download#65]

Diagrama de clases

Diagrama de clases

Screenshots

El uso de BlueDoc es muy sencillo, se pueden documentar archivos de forma individual…

O también se pueden documentar conjuntos de archivos de un proyecto. Esto se realiza desde la linea de comandos o se puede integrar a editores como TextPad.

a Esta es la página web que produce BlueDoc. Nos muestra toda la información de nuestras clases de forma sencilla y ordenada.
Como se puede observar, documentar archivos en C++ es sumamente sencillo con esta herramienta.



One Response so far.

  1. keogh says:

    Interesante este proyecto, yo no uso C++ pero ojala que los que si lo hagan les sirva mucho.

    s4lu2


Subscribe to email feed



ziff-davis

Believe in technolog

Ziff Davis Publishing es la más grande editorial de contenidos ...

software-architect-salary

Introducción a SCRU

SCRUM es una plataforma de desarrollo ágil que da las ...

ecluipse_s

Eclipse 4.4 Luna ha

Eclipse Foundation con un nuevo logo y diseño web ha ...

Las 97 cosas que deb

Ser el arquitecto de una aplicación es una gran responsabilidad ...

artifactory

Artifactory, el gest

Artifactory es un repositorio de archivos binarios que permite tener control ...

ziff-davis

Believe in technolog

Ziff Davis Publishing es la más grande editorial de contenidos ...

software-architect-salary

Introducción a SCRU

SCRUM es una plataforma de desarrollo ágil que da las ...

ecluipse_s

Eclipse 4.4 Luna ha

Eclipse Foundation con un nuevo logo y diseño web ha ...

Las 97 cosas que deb

Ser el arquitecto de una aplicación es una gran responsabilidad ...

artifactory

Artifactory, el gest

Artifactory es un repositorio de archivos binarios que permite tener control ...