Documentacin en la codificacin

Ingeniera de Software II

Las convenciones de nombrado hacen los programas ms entendibles hacindolos ms fciles de leer. Tambin pueden proporcionar informacin sobre la funcin del identificador

Las convenciones de cdigo son importantes para los programadores por numerosas razones: El 80% del tiempo de vida de un programa se dedica al mantenimiento del mismo. En pocas ocasiones, el programa es mantenido durante toda su vida til por su autor original.

Las convenciones de cdigo aumentan la legibilidad de los programas, permitiendo a los desarrolladores comprender nuevo cdigo rpida y perfectamente. Si se distribuye el cdigo fuente como un producto, se necesita asegurar que est tan bien empaquetado y limpio como cualquier otro producto que se cree.

Convenciones del lenguaje para el nombrado de variables

La

eleccin de nombres de identificadores significativos es crucial para la legibilidad. Los nombres de variables deberan ser cortos y llenos de significado. La eleccin de una variable debera ser mnemnica-es decir, diseada para indicar al observador casual su utilizacin.

 Se deben evitar los nombres de variable de un

slo carcter, excepto para los contadores. Algunos nombres comunes de este tipo de variables son: i, j, , para enteros. Los nombres de variables no deben empezar con los caracteres subrayado "_" , nmeros o dollar "$".

 La primera letra del nombre en minsculas, y con

la primera letra de cada palabra interna en maysculas. Hay que intentar inicializar las variables locales donde se declaren. La nica razn para no inicializar una variable donde se declara es si el valor inicial depende de algn clculo que debe ocurrir primero.

Convenciones del lenguaje para el nombrado de mtodos

Los mtodos deberan ser verbos, en maysculas y minsculas con la primera letra del nombre en minsculas, y con la primera letra de cada palabra interna en maysculas.
insertar ();
eliminarVenta();

Convenciones del lenguaje para el nombrado de constantes

En cuanto a los nombres de constantes de clases deberan escribirse todo en maysculas con las palabras separadas por guin bajo (_).
static final int MIN_ALTURA = 4; static final int MAX_ALTURA = 999;

Convenciones del lenguaje para la identificacin de la clase

Los nombres de clases deben ser mezclas de maysculas y minsculas, con la primera letra de cada palabra interna en maysculas. Debemos intentar mantener los nombres de clases simples y descriptivos. Debemos usar palabras completas y evitar acrnimos y abreviaturas.
class Areas;

class Circulos;

10

Convenciones del lenguaje para la identacin

La identacin se utiliza para mejorar la legibilidad del cdigo fuente por parte de los programadores, la identacin se utiliza para delimitar la estructura del programa permitiendo visualizar bloques de cdigo.

11

Longitud de Lnea: Evitar lneas mayores de 80 caracteres, ya que no son bien manejadas por muchos terminales y herramientas. Ruptura de Lneas: Cuando una expresin no entre en una sola lnea, se debe romper de acuerdo a estos principios generales: Romper despus de una coma. Romper antes de un operador Preferir las rupturas de alto nivel a las de bajo nivel. Alinear la nueva lnea con el principio de la expresin al mismo nivel de la lnea anterior.

12

Convenciones del lenguaje para los comentarios

Descripcin de cdigo. Los comentarios pueden

ser utilizados para explicar el cdigo y la intencin del programador. Descripcin algortmica. A veces, el cdigo fuente contiene una solucin a un problema digno de mencin especfica. En tales casos, los comentarios pueden contener una explicacin de la metodologa.

13

 Inclusin de recursos: Avisos de derechos de

autor, fecha de creacin, versin del producto, contacto con el propietario y/o creador, etc. puede ser embebido en cdigo fuente como comentarios. Debugging. Una prctica comn es comentar un fragmento de cdigo, de modo que no se ejecutar en el programa final, pero si da una idea de que se podra o se quiso haber hecho en el programa, a veces tambin es usado para dejar las bases de una nueva versin del software.
14

 Documentacin. Mantener la documentacin de

comentarios del cdigo fuente se considera como una forma de simplificar el proceso de documentacin, as como aumentar las posibilidades de que la documentacin se mantendr al da con los cambios en el cdigo.

15