Wiki

Has cargado una revisión vieja del documento! Si la guardas crearás una versión nueva con estos datos.

====== 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.

===== Estructuras de Código Fuente =====
La siguientes estructuras de código fuente que deben ser documentadas:

* Clases
  * Métodos de Clases
  * Ventanas
  * Funciones y Eventos de Ventanas
  * Formularios
  * Paquetes de base de datos
  * Funciones y Procedimientos de bases de datos

===== Tipos de documentación =====
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|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: [[ada:howto:sicoferp:factory:migracionsicoferp:process:backend:guiadocmicroservicios|Documentación Externa de Microservicios]]

===== Estructura de documentación =====

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

<code java>
/**

Título

Descripción

Retorno

Acceso

Argumentos

Modo de Uso

Autor

Fecha

deprecated

throws

Sección para revisiones y versionamiento

Copyright Año ADA, Inc. All rights reserved.
*/
</code>

==== Definición de Columnas ====

=== Título ===
Nombre de la [[#Estructuras de Código Fuente|Estructura de Código Fuente]] que se documentará.

=== Descripción ===
Describe el objetivo de la [[#Estructuras de Código Fuente|Estructura de Código Fuente]]. Esta descripción debe ser clara y concisa.

=== Retorno ===
Describe el valor de salida de un método. No aplica para definiciones de clases.

=== Argumentos ===
Describe los parámetro de un método.

=== Modo de Uso ===
Este campo se utiliza para presentar un ejemplo de la forma de invocar o ejecutar la [[#Estructuras de Código Fuente|Estructura de Código Fuente]].

=== Autor ===
Indica quién escribió la [[#Estructuras de Código Fuente|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 **nombre.apellido@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.

**Fecha**
Este campo registra la fecha inicial de creación de la [[#Estructuras de Código Fuente|Estructura de Código Fuente]]

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

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

=== Sección para revisiones y versionamiento ===

=== Copyright [Año] ADA, Inc. All rights reserved ===
Este campo se utiliza para registrar los derechos reservados de la [[#Estructuras de Código Fuente|Estructura de Código Fuente]] se debe diligenciar la columna **Año** según la vigencia de creación.

[[ada:howto:sicoferp:factory|←Volver atras]]

Resumen de la edición

Wiki

Herramientas de usuario

Herramientas del sitio

Herramientas de la página