Esta es un área dedicada a la documentación del programa / función/método. Contiene comentarios explicando su finalidad, fecha de creación, parámetros, retornos y modificaciones realizadas.
Existen dos tipos de encabezado, de acuerdo con lo que se muestra a continuación:
Encabezado de fuente:
Arriba podemos observar el área de identificación de una función de la línea Microsiga Protheus.
Observe que está formada por tags que pueden identificarse fácilmente. Estas tags se utilizan para integrar la documentación del código con el sitio de documentación de la línea Microsiga Protheus.
En la siguiente tabla resaltamos la función de cada una de las tags:
{Protheus.doc} | Identifica el inicio del bloque de documentación. Debe estar precedido por el nombre de la función o método y en el párrafo siguiente debe tener la descripción completa del bloque. |
@param | Parámetros de entrada, listados en la orden de paso. Ejemplo:
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@param cFederalId Informe.
@param nErro Retorna.
@param aIDs Retorna.
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
@protected | Si se incluye indica que la función tiene uso restringido por la GDP creadora y no puede reaprovecharse en personalizaciones y/o integraciones.
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@protected
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
@author | Autor o revisor del bloque.
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@author Eduardo Riera
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
@version | Versión de la línea de producto Microsiga Protheus donde se inició el bloque. Utilice la nomenclatura definida por la GDP de Framework, ejemplo:
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@version MP11.5
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
build | Versión mínima de la Build del Application Server que es compatible con el bloque.
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@build 7.00.100812P - Sep 1 2010
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
@deprecated | Si se incluye indica que la función ya no tiene mantenimiento y/o se sustituyó por otra, y ya no se utiliza. Por ello, se recomienda su sustitución por una nueva función.
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@deprecated
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
@see | Indica las funciones que deben observarse por el desarrollador antes de su utilización. "Vea también"
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@see FWTeste2,FWTeste3,FWTeste4
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
@since | Fecha de creación de la rutina.
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@since 9/10/1995
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
@return | Indicador del retorno de la función
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@return ExpL: indica si se ejecutó la rutina correctamente.
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
@todo | Indicativo de función incompleta o con pendencias de desarrollo.
//----------------------------------------------------------
/*/{Protheus.doc} FWTeste1()
Función prueba
@todo proteger la función de llamadas por personalización.
/*/
//----------------------------------------------------------
Function FWteste1(cFederalId,nErro,aIDs) |
@sample | Ejemplo de uso del bloque. |
@obs | Observación complementaria al bloque. |
