close Warning: Failed to sync with repository "ogBrowser-Git": (1366, "Incorrect string value: '\\xF0\\x9F\\x93\\xA6 I...' for column 'message' at row 1"); repository information may be out of date. Look in the Trac log for more information including mitigation strategies.

Changes between Version 2 and Version 3 of ApiFunciones


Ignore:
Timestamp:
Jun 12, 2009, 12:05:44 PM (16 years ago)
Author:
ramon
Comment:

Introducción

Legend:

Unmodified
Added
Removed
Modified

  • ApiFunciones

    v2 v3  
    55== Introducción ==
    66
    7 ''(descripción de la API unificada)''
     7Los desarrolladores de la interfaz de programación del proyecto deben seguir estas reglas de estilo:
    88
     9 * Las reglas de la API se cumplirán independientemente del lenguaje de programación utilizado.
     10 * La documentación del código debe se r compatible con [http://www.stack.nl/~dimitri/doxygen/ Doxygen].
     11 * Debe incluirse toda la información necesaria en las cabeceras de las funciones (descripción, formato, salidas, notas, etc.).
     12 * Deben incluirse comentarios descriptivos en los bloques de código.
     13 * Las funciones devolverán un código de salida al estilo Unix, que indique si se ha ejecutado correctamente o se ha producido alguno de los tipos de errores definidos. En caso de error, también mostrará el mensaje correspondiente.
     14 * Todos los nombres de funciones y variables deben estar escritos en inglés, deben ser descriptivos y fáciles de recordar.
     15 * Nombres de funciones al estilo Rembo-C (sólo con las iniciales en mayúsculas), pero sin copiarlos de Rembo-C. Según se estime oportuno, los nombres de funciones podrán tener un prefijo indicativo del proyecto o del componente del proyecto al que pertenece.
     16 * Las constantes y variables globales deben ir escritas en mayúsculas.
    917
    1018== Parámetros ==