Estándares de programación

Solo disponible en BuenasTareas
  • Páginas : 6 (1295 palabras )
  • Descarga(s) : 11
  • Publicado : 25 de agosto de 2010
Leer documento completo
Vista previa del texto
Variables. Se nombrará las variables según su correspondencia a la funcionalidad precisada. Las variables auxiliares deberán empezar con minúscula. Aparte de eso, no tendrán otras restricciones para su nombramiento.
Excepción: Cuando el programador vea muy necesario, podrá usar un prefijo de 2 y sólo 2 letras para las variables de tipos atómicos. Dichos prefijos deberán indicarse comocomentario en la parte superior del módulo después del comentario sobre el módulo (que se detallará posteriormente), indicando qué prefijo corresponde a qué tipo de datos. Seguido al prefijo, en el nombre de la variable deberá seguir una letra mayúscula. En cambio, para las definiciones y variables no-atómicas usaremos las siguientes convenciones.
Clases: El nombre de las clases definidas por elprogramador deberán empezar con mayúscula. Por ejemplo Class Persona. Cada clase tendrá un alias implícito de 3 letras minúsculas, que servirán de prefijo para sus instancias. Ejemplo, para la clase Persona, el prefijo será “per”.
Objetos: Los objetos usarán una notación de tres letras, es decir tendrán un prefijo de 3 letras correspondiente a la clase de la cual es instancia el objeto. Después delprefijo, el identificador del objeto deberá iniciar con mayúscula. Por ejemplo perCarlos.
Variable miembro de las clases: Se las tratará como a cualquier variable. Es decir que los miembros de las clases, si son de tipo “atómico” no tendrán ningún tipo de prefijo o notación especial, como se dijo anteriormente. Si es que los miembros son instancias de alguna clase (y no tipo atómico), se usará elprefijo de tres letras, tal como cualquier objeto.
Métodos y procedimientos. Los métodos (o funciones) y procedimientos estarán expresados en infinitivo, no en imperativo. En el caso de las funciones, si es que estas devuelven un objeto, usarán los prefijos de objeto mencionados. No habrá ninguna diferencia adicional entre procedimientos y funciones en la notación.
Parámetros: Los parámetros porreferencia usarán el prefijo “ref_”. Los parámetros por valor no tendrán ningún prefijo. Si la función o procedimiento utiliza parámetros por referencia, también deberá llevar el prefijo.
Métodos de las clases: Los métodos de las clases, de igual forma estarán en infinitivo
Constantes: Los nombres de las constantes definidas por el programador estarán en MAYÚSCULAS, más ningún prefijoespecial. Ej. HORAS = 24.
Precedencia de Prefijos: El orden de los prefijos a colocar, en caso de que haya más de uno. De mayor precedencia a menor precedencia. Los prefijos en la misma fila representan igual precedencia.
Prefijo de función o procedimiento que modifica parámetros
Prefijo de parámetro por referencia
Prefijo opcional de variable atómica, Prefijo de objeto

Librerías y Módulos declase: Los archivos que sólo contengan funciones, y de propósito general, que llamaremos “librerías” se deberán ubicar con el prefijo “lib-” cuyo padre es el directorio raíz de fuentes. Los módulos de clase deberán ubicarse con el prefijo “cla-“. Sólo se permitirá una clase por tabla del modelo de datos.
Nominación: Las librerías, además deberán llevar el prefijo “lib”, seguidos del nombreidentificador comenzando en mayúscula. Los módulos de clase deberán tener como nombre el nombre de la clase a la que pertenecen, sin ningún prefijo adicional. En el caso de que en la tecnología a emplear el código fuente no sea el ejecutable (es decir, si están en distintos archivos), se añadirá el prefijo ff_ en el nombre del archivo, para distinguir el fuente de los ejecutables. En caso de que en latecnología a emplear el código fuente sea el ejecutable, no se usará prefijo de código fuente.
Comentarios de los archivos fuente: Cada módulo deberá tener en las primeras líneas, antes que cualquiera una descripción breve del módulo, su propósito y sus dependencias. El comentario no deberá sobrepasar las 5 líneas. También deberá añadir comentarios antes de la definición de cualquier función,...
tracking img