Diferencias

Muestra las diferencias entre dos versiones de la página.

--- ada:howto:sicoferp:factory:sourcecodedocumentation [2021/09/27 13:41]
administraidor
+++ ada:howto:sicoferp:factory:sourcecodedocumentation [2021/09/27 15:21] (actual)
administraidor
@@ Línea 9: / Línea 9: @@
   * Ventanas
   * Funciones y Eventos de Ventanas
-  * Formularios
+  * Formularios y Vista Web (html)
   * Paquetes de base de datos
   * Funciones y Procedimientos de bases de datos
@@ Línea 32: / Línea 32: @@
 Retorno
-Acceso
 Argumentos
@@ Línea 43: / Línea 41: @@
 Fecha
-deprecated
+Deprecated
-throws
+Throws
-Sección para revisiones y versionamiento
+Revision History
 Copyright Año ADA, Inc. All rights reserved.
 */
 </code>
+=== Consideraciones ===
+  * Los nombres de los campos pueden variar según el lenguaje de programación.
 ==== Definición de Columnas ====
@@ Línea 62: / Línea 64: @@
 === Retorno ===
-Describe el valor de salida de un método. No aplica para definiciones de clases.
+Describe el valor o valores de salida de un método. No aplica para definiciones de clases.
 === Argumentos ===
-Describe los parámetro de un método.
+Describe los parámetros de un método.
 === Modo de Uso ===
@@ Línea 71: / Línea 73: @@
 === 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.
+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 con la siguiente plantilla:
-**Fecha**
+**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
+=== Fecha ===
 Este campo registra la fecha inicial de creación de la [[#Estructuras de Código Fuente|Estructura de Código Fuente]]
-=== deprecated ===
+=== 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 ===
+=== Throws ===
-Sólo aplica para métodos describe las excepciones que pueden ser lanzadas por el método.
+Sólo aplica para métodos. Describe las excepciones que pueden ser lanzadas por el método.
-=== Sección para revisiones y versionamiento ===
+=== Revision History ===
+Esta sección de documentación es utilizada para registrar las evoluciones de la [[#Estructuras de Código Fuente|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:
+.0 - carlos.torres@ada.co - 27/07/2021 08:39:40 : Initial version. - edixson.matos@ada.co - 27/07/2021 14:00:05
 === Copyright [Año] ADA, Inc. All rights reserved ===
@@ Línea 89: / Línea 103: @@
+==== Alcance de la plantilla ====
+A continuación se presenta una matriz de alcance de la plantilla base de documentación según la [[#Estructuras de Código Fuente|Estructura de Código Fuente]]
+| ^Clase ^Método Clase ^Ventana ^Evento/Función Ventana ^Formulario/Vista Web ^Paquete DB ^Funcion/Procedure DB ^
+^Título|X |X |X |X |X |X |X |
+^Descripción|X |X |X |X |X |X |X |
+^Retorno| |X | |X | | |X |
+^Argumentos| |X | |X | | |X |
+^Modo de Uso|X |X |X |X |X |X |X |
+^Autor|X |X |X |X |X |X |X |
+^Fecha|X |X |X |X |X |X |X |
+^Deprecated|X |X |X |X |X |X |X |
+^Throws| |X | |X | | |X |
+^Revision History|X |X |X |X |X |X |X |
+^Copyright|X |X |X |X |X |X |X |
+===== Herramientas para generar documentación interna =====
+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:
+^Lenguaje ^Herramienta de Generación de Plantilla ^Herramienta para generación de Reporte de Docuentación Técnica ^
+|Java|[[https://www.oracle.com/co/technical-resources/articles/java/javadoc-tool.html|Javadoc]] |[[https://www.oracle.com/co/technical-resources/articles/java/javadoc-tool.html|Javadoc]] |
+|Powerbuilder|[[https://www.autohotkey.com/|Autohotkey]] |[[http://www.pbdr.com/software/pbdoc.htm|PBDoc]] |
+|Base de Datos|[[https://www.autohotkey.com/|Autohotkey]] |Manual|
 [[ada:howto:sicoferp:factory|←Volver atras]]

Wiki

Herramientas de usuario

Herramientas del sitio

Diferencias

Herramientas de la página