Vowel Sound

UNIVERSIDAD NACIONAL AUTÓNOMA DE MÉXICO

Facultad de Estudios Superiores Campus Aragón

Guía de Estilo

Una meta importante al codificar es hacer que el código sea legible y entendible. Los programas

bien escritos son fáciles de depurar, de mantener y tienen pocos errores. Escribir un programa es

un poco como escribir un ensayo, cuando se escribe uno, el mensaje es más convincente si está

acompañado por una puntuación y gramática adecuada. Cuando se escriben programas de

computadora, se debe seguir el mismo principio. Es aún más importante cuando un el programa

debe ser asignado para mantenimiento y soporte por largos periodos de tiempo. Apreciará la

importancia del estilo cuando tenga que dar mantenimiento al código de otros.

Código

· Mantenga el programa y sus métodos cortos y manejables (150 líneas máximo por

función)

· Use especificadores de idioma en los caracteres

· Evite los números mágicos, en su lugar use nombres simbólicos

Convenciones de nombres. Aquí hay algunos principios cuando se escogen los nombres de sus

variables, métodos y clases

· Use nombres significativos. Ellos apoyan el propósito de la variable. Escoja nombres fáciles

de pronunciar y evite las abreviaciones crípticas. Por ejemplo use muestrasPorHora o

muestrasHora en lugar de mph. Use polígono en lugar de p o poli o pgon.

· Sea consistente

· Los nombres de las variables boolean deben tener nombre significativos y no ambiguos,

por ejemplo esPrimo, esVacio o contiene()

· Use nombre cortos ( como i) solo para variables de corta vida e índices en ciclos. Use

nombres descriptivos para variables que tengan un propósito más importante.

· Evite nombre genéricos como temp, aux y nombres sin significado como princetza.

Use la terminología del dominio del problema

· Nombre las constantes por su significado, no pos su valor, por ejemplo, use

DIAS_DE_LA_SEMANA en lugar de SIETE

Identificador Reglas Ejemplo

Variables Nombres cortos, pero

significativos, que comuniquen

al observador casual lo que la

variable representa, más que

como es usada. Inicie con una

letra minúscula y use estilo

camello (camel)

masa

millaPorHora

esPrimo

Constante Use todas la letras mayúsculas

y separadas por guión bajo.

PI

IVA_FRONTERA

Clase Un pronombre que comunique

lo que la clase representa.

Inicie con una mayúscula y use

estilo camello para las

palabras internas

class Complejo

class Fraccion

class NumeroTelefono

Método Un verbo, proferentemente

infinitivo, que comunique lo

que el método hace. Inicie con

minúscula y continue con

estilo camel

mover()

dibujarLineas()

encolar()

Comentarios. Los programadores usan comentarios para auxiliar al lector (o al evaluador) a

entender como y porque el programa trabaja. Como una regla general, el código explica a la

computadora y al programador que es lo qué se está haciendo; el comentario explica porque se

hace esto. Los comentarios pueden aparecer en cualquier parte donde los espacios en blanco son

permitidos. El compilador los ignora.

· Comentarios en línea: al final de la línea los comentarios inician con // y finalizan con un

fin de línea

· Comentarios de bloque: un comentario de bloque inicia con /* y finaliza con un */.

Cualquier texto entre ellos es ignorado

· Comentarios remarcados. Un comentario remarcado es un caso especial, el cual esta

diseñado para llamar la atención

/*---------------------------------------------------------------------------------------------------------------

* Este es un comentario remarcado para llamar su atención

* ¿Dime que no lo habías visto?

*-----------------------------------------------------------------------------------------------------------------*/

· Comentarios de javadoc: este es un caso especial en el cual el comentario inicia con /**.

Ese caso es típicamente utilizado para generar la API para una clase

Los buenos programadores escriben código autodocumentado

· Asegúrese de que los comentarios estén de

...