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:23] 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 50: | 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 60: | 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 102: | Línea 106: | ||
| 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]] | 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 ^Ventana ^Evento ^Formulario ^Paquete DB ^Funcion/Procedure DB ^ | + | | ^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 | | ^Título|X |X |X |X |X |X |X | | ||
| ^Descripción|X |X |X |X |X |X |X | | ^Descripción|X |X |X |X |X |X |X | | ||
| Línea 115: | Línea 119: | ||
| ^Copyright|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.1632752603.txt.gz · Última modificación: 2021/09/27 14:23 por administraidor
Herramientas de la página
