Herramientas de usuario
ada:howto:sicoferp:factory:sourcecodedocumentation
Diferencias
Muestra las diferencias entre dos versiones de la página.
| Ambos lados, revisión anterior Revisión previa Próxima revisión | Revisión previa | ||
|
ada:howto:sicoferp:factory:sourcecodedocumentation [2021/09/27 14:02] administraidor |
ada:howto:sicoferp:factory:sourcecodedocumentation [2021/09/27 15:21] (actual) administraidor |
||
|---|---|---|---|
| Línea 9: | Línea 9: | ||
| * Ventanas | * Ventanas | ||
| * Funciones y Eventos de Ventanas | * Funciones y Eventos de Ventanas | ||
| - | * Formularios | + | * Formularios y Vista Web (html) |
| * Paquetes de base de datos | * Paquetes de base de datos | ||
| * Funciones y Procedimientos de bases de datos | * Funciones y Procedimientos de bases de datos | ||
| Línea 32: | Línea 32: | ||
| Retorno | Retorno | ||
| - | |||
| - | Acceso | ||
| Argumentos | Argumentos | ||
| Línea 52: | Línea 50: | ||
| */ | */ | ||
| </code> | </code> | ||
| + | |||
| + | === Consideraciones === | ||
| + | |||
| + | * Los nombres de los campos pueden variar según el lenguaje de programación. | ||
| ==== Definición de Columnas ==== | ==== Definición de Columnas ==== | ||
| Línea 62: | Línea 64: | ||
| === Retorno === | === 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 === | === Argumentos === | ||
| Línea 71: | Línea 73: | ||
| === Autor === | === 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: |
| + | |||
| + | **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 === | === Fecha === | ||
| Línea 95: | 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]] | [[ada:howto:sicoferp:factory|←Volver atras]] | ||
ada/howto/sicoferp/factory/sourcecodedocumentation.1632751370.txt.gz · Última modificación: 2021/09/27 14:02 por administraidor
Herramientas de la página
