Changes between Version 1 and Version 2 of Metodologia/Administracion/EstandaresDesarrollo


Ignore:
Timestamp:
Jun 10, 2013, 4:18:15 PM (11 years ago)
Author:
aaraujo
Comment:

Redacción de plantilla de estándares de desarrollo

Legend:

Unmodified
Added
Removed
Modified
  • Metodologia/Administracion/EstandaresDesarrollo

    v1 v2  
    77
    88[A continuación se deben identificar los estándares de desarrollo que serán implementados en el desarrollo de la aplicación]
     9
     10== Normas de Codificación ==
     11
     12 * Cada archivo del proyecto deberá incluir al inicio del mismo, la licencia con la cual se distribuyen los códigos. El cuerpo de la licencia que se debe incluir es el siguiente:
     13
     14{{{
     15/*
     16* Tibisay Movil
     17*
     18* Copyright (C) 2013 Antonio Araujo (aaraujo@cenditel.gob.ve),
     19* Jose Ruiz (jruiz@cenditel.gob.ve),
     20*
     21* CENDITEL Fundacion Centro Nacional de Desarrollo e Investigacion en
     22* Tecnologias Libres
     23*
     24* Este programa es software libre; Usted puede usarlo bajo los terminos de la
     25* licencia de software GPL version 2.0 de la Free Software Foundation.
     26*
     27* Este programa se distribuye con la esperanza de que sea util, pero SIN
     28* NINGUNA GARANTIA; tampoco las implicitas garantias de MERCANTILIDAD o
     29* ADECUACION A UN PROPOSITO PARTICULAR.
     30* Consulte la licencia GPL para mas detalles. Usted debe recibir una copia
     31* de la GPL junto con este programa; si no, escriba a la Free Software
     32* Foundation Inc. 51 Franklin Street,5 Piso, Boston, MA 02110-1301, USA.
     33*
     34*/
     35}}}
     36
     37 * Seguir y mantener un esquema de indentación en todos los códigos fuentes del proyecto. La unidad para mantener la indentación es el tabulador. Esto permitirá mejorar la legibilidad del código fuente por parte de los programadores.
     38
     39 * La codificación de caracteres a utilizar será {{{ISO-8859-1}}} o {{{latin1}}} para todos los archivos de texto.
     40
     41
     42=== Nombramiento ===
     43
     44 * Los nombres de las variables, clases y demás estructuras se utilizarán en inglés dentro del código fuente. Pero las vistas para el usuario estarán redactadas en español.
     45
     46 * Los nombres de clases deben comenzar con una letra mayúscula y utilizar letras mayúsculas como separador de palabras, el resto de las letras deben ir en minúscula. Por ejemplo: {{{SignatureDocument}}}.
     47
     48 * Los nombres de funciones deben comenzar con una letra minúscula y utilizar letras mayúsculas como separador de palabras, el resto de las letras deben ir en minúscula. Por ejemplo: {{{getDigneture()}}}.
     49
     50 * Las variables de tipo puntero deben tener el caracter {{{p}}} como prefijo. Por ejemplo: {{{pBDoc}}}.
     51
     52 * Las variables globales deben utilizar sólo letras mayúsculas y utilizar el caracter {{{_}}} como separador de palabras. Por ejemplo: {{{VALID_TIME}}}
     53
     54
     55
     56