Fábrica - Documentación de Código Fuente

Esta sección esta dedicada a la definición del proceso de documentación de código fuente que se debe implementar en las estructuras de código fuente generado en las aplicaciones de la compañía.

La siguientes estructuras de código fuente que deben ser documentadas:

• Clases
• Métodos de Clases
• Ventanas
• Funciones y Eventos de Ventanas
• Formularios y Vista Web (html)
• Paquetes de base de datos
• Funciones y Procedimientos de bases de datos

Se definen los siguientes tipos de documentación:

• Interna: Utilizada en el código fuente de las aplicaciones de la compañia. Ver Estructuras de Código Fuente. Esta documentación se caracteriza porque está interna en el código fuente y puede ser consultada directamente consultando las estructuras de código o utilizando una aplicación de generación de documentación técnica según el lenguaje de documentación.
• Externa: Utilizada en el código fuente de las aplicaciones de la compañia del proceso de migración. Esta documentación es generada complementaria a la documentación interna. Este proceso ya esta definido en la siguiente sección: Documentación Externa de Microservicios

A continuación se define la Plantilla Base de documentación que debe ser implementada en las Estructuras de Código Fuente de las aplicaciones de la compañía

/**
 
Título
 
Descripción
 
Retorno
 
Argumentos
 
Modo de Uso
 
Autor
 
Fecha
 
Deprecated
 
Throws
 
Revision History
 
Copyright Año ADA, Inc. All rights reserved.
*/

• Los nombres de los campos pueden variar según el lenguaje de programación.

Nombre de la Estructura de Código Fuente que se documentará.

Describe el objetivo de la Estructura de Código Fuente. Esta descripción debe ser clara y concisa.

Describe el valor o valores de salida de un método. No aplica para definiciones de clases.

Describe los parámetros de un método.

Este campo se utiliza para presentar un ejemplo de la forma de invocar o ejecutar la Estructura de Código Fuente.

Indica quién escribió la Estructura de Código Fuente que se refiere el comentario. Si son varias personas se escriben los nombres separados por comas. El nombre del autor debe ser escrito según el correo del usuario de la compañía con la siguiente plantilla:

nombre.apellido@ada.co Ejemplo: carlos.torres@ada.co el cual es otorgado al empleado al ingresar.

Si es un autor externo se debe registrar el nombre completo más el correo personal.

Nombres Apellidos, correo@empresa.com Ejemplo: Pepe Perez, pepe.perez@gmail.com

Este campo registra la fecha inicial de creación de la Estructura de Código Fuente

Indica que la Estructura de Código Fuente es antigua y que no se recomienda su uso porque posiblemente desaparecerá en versiones posteriores o será reemplazada.

Sólo aplica para métodos. Describe las excepciones que pueden ser lanzadas por el método.

Esta sección de documentación es utilizada para registrar las evoluciones de la Estructura de Código Fuente. Las evoluciones de código fuente se debe registrar con la siguiente plantilla:

Número de Revisión - Autor evolución - Fecha : Descripción - Autor revision par - Fecha revison par

Ejemplo:

1.0 - carlos.torres@ada.co - 27/07/2021 08:39:40 : Initial version. - edixson.matos@ada.co - 27/07/2021 14:00:05

Este campo se utiliza para registrar los derechos reservados de la Estructura de Código Fuente se debe diligenciar la columna Año según la vigencia de creación.

A continuación se presenta una matriz de alcance de la plantilla base de documentación según la Estructura de Código Fuente

Según el lenguaje de programación se definen algunas de las herramientas que ayudan a simplificar la generación de la documentación del código fuente:

←Volver atras