Documentacin

Se requiere la documentacin de la aplicacin general. Se va a realizar la documentacin de cada uno de los mdulos en el siguiente orden:

NS.BBDD NS.Utils NS.IO NS.UI NSComponents Integracin de los formularios

Esta documentacin se va a llevar dentro de un blog alojado en uno de los servidores. Siendo la ubicacin actual del mismo dentro de la ip: 169.254.1.181:1080/blog. El usuario y contrasea para acceder al mismo es dentro son:
User: admin Password: aDMIN1234+

Reglas de documentacin

Para que toda la documentacin sea estructurada correctamente y de la misma manera, se llevar el siguiente esquema:

Categoria de proyecto. Siendo este BRS Studio. Dentro del mismo habr una subcategora que ser el mdulo del proyecto. Posteriormente habr un post creado con el nombre del mdulo explicando las caractersticas del mismo. Y los correspondientes posts con las distintas clases que componen el proyecto, por ejemplo: Para la estructura de NS.BBDD, si quisiramos crear la documentacin para la clase ITransactions se crear un post para la misma con la categora BRS Studio, con la subcategora NS.BBDD. Tambin habr que crear un artculo con el esquema de clases a parte dentro de la categora en cuestin, si est es bastante densa, tiene bastantes controles, se puede separar en distintos esquemas de clases para obtener una mejor definicin.

Para los posts de cada una de las clases, se tiene que crear una breve descripcin de las funcionalidades de esa clase y luego una definicin de los mtodos en cuestin y los posibles campos privados. Para continuar con un criterio, los campos sern descritos al principio del artculo y se continuar con los mtodos, con la siguiente estructura de tablas.

Nombre Mtodo Parmetros Nombre Tipo Parametro Retorno Tipo Informacin Comentarios

Descripcin

Pongamos el ejemplo del siguiente mtodo Select, dentro de la clase BBDDSQLLite.

Nombre Mtodo Parmetros sql String Retorno Informacin DataTable Creamos los objetos necesarios para realizar la consulta SQL(Command, DataAdapter) Devolvemos null y un evento en caso de que exista algn error. Tenemos un bloque try catch para la captura. Este mtodo no contiene documentacin dentro del cdigo Select Descripcin Se genera el DataTable de la consulta solicitada del SQL.

Comentarios

Como podemos ver, hemos descrito un poco la funcionalidad interna del mtodo dentro del recuadro de informacin y hemos indicado los posibles errores que pensamos que existe segn nuestro criterio desde comentarios. Estos dos campos no son del todo obligatorios de que sean rellenados.

Para una correcta visualizacin dentro del blog, lo ms recomendable sera crear inicialmente un documento Word y a posteriori copiarlo y pegarlo dentro del documento del blog.

Esta tarea, puede resultar bastante tediosa, no obstante, existe una manera de automatizarla.

Como hemos indicado, lo recomendable sera crear un documento Word intermedio, ya que resulta interesante para su posterior consulta y comodidad de actualizacin. Desde programacin es posible tener la automatizacin de la creacin de documentos en Word. Se propone, crear una aplicacin con una librera en Word, que nos cree automticamente documentos en Word, que esa librera sea llamada desde otra aplicacin que sea capaz de abrir los ficheros del proyecto, es decir, los ficheros .cs.

Mediante est apertura de ficheros podemos automatizar toda la generacin de documentos.

Es muy importante crear est librera lo ms reutilizable posible, ya que puede resultar de utilidad en futuras implementaciones, creacin de informes, creacin de aplicaciones de documentos automticamente, creacin de cartas

Si se opta por crear la aplicacin, lo recomendable sera:

Realizar pruebas con las libreras de interoperabilidad de Word, se puede comenzar a tomar como referencia los siguientes enlaces: http://copstone.com/2010/05/crear-un-documentomsword-con-c-sharp/ http://www.dotnetperls.com/word

o -

Existe mucha ms documentacin al respecto en internet.

Crear el diagrama de clases de como plantear esa librera, para evitar errores en la mantenibilidad y reutilizacin del cdigo. Comenzar a generar la aplicacin.