Documento de Implementacion



Descargar 50.29 Kb.
Fecha de conversión21.06.2020
Tamaño50.29 Kb.


PARIS



Tipo doc.



ESTÁNDAR DE IMPLEMENTACION

Código RQ-ERQ

Actividad

Implementación

Creación y revisión Nicolás Cestari – Rosina Ordoqui

Versión V 1.0




Fecha 20/11/2019

Historia de revisiones

Fecha

Versión

Descripción

Autor

28/08/2005

1.0

Creación del Documento

Nicolás Cestari

29/08/2005

1.0

Revisión

Rosina Ordoqui

 

 

 

 

 

 

 

 

Contenido

PARIS 1

Historia de revisiones 1

Contenido 2

1. Convenciones Generales 3

1. Convenciones Generales 3

1. Convenciones Generales 3

2. Convenciones Específicas 4

2. Convenciones Específicas 4

2. Convenciones Específicas 4

2.1. Variables 4

2.1. Variables 4

2.2. Constantes 4

2.2. Constantes 4

2.3. Indentación 5

2.3. Indentación 5

2.4. Propiedades 6



2.4. Propiedades 6

3. Otros 6

3. Otros 6

3. Otros 6



  1. Convenciones Generales

Para introducir comentarios de documentación en el código, se utilizará los comentarios mediante tags de XML. Los tags usados serán:

Tag

Descripción



Permite que el texto se vea como código.



Permite que varias líneas de texto se vean como código.



Indica un ejemplo.



Identifica una excepción que el método lanza.



Crea una tabla. Puede contener un cabezal, indicado mediante el tag , y los ítems son indicados mediante el tag .




Permite agregar texto en otros tags.




Describe un parámetro de un método o constructor.




Identifica una palabra como el nombre de un parámetro de un método o constructor.




Se utiliza para indicar la accesibilidad que posee un método, propiedad o constructor.



Describe una clase o tipo.



Describe el valor de retorno de un método.



Especifica un link.



Genera una entrada See Also (vea también…).



Se utiliza para describir un miembro de una clase o tipo.



Describe una propiedad.

Para el caso de atributos, variables y constantes, los comentarios se deberán escribir en la línea inmediatamente superior a sus declaraciones. Para los métodos, constructores y propiedades, el comentario de explicación se deberá insertar en la primera línea dentro del cuerpo del método.

Para la generación de comentarios se utilizará la herramienta NDOC.

Referencias:


  • http://www.ecma-international.org/publications/standards/Ecma-334.htm



  1. Convenciones Específicas

    1. Variables

  • Los nombres de las variables deberán ser representativos a lo que significan en el dominio del problema.

  • Dichos nombres deberán ser escritos en mixed-case, comenzando con letra minúscula.

  • De la misma manera que se tratarán las variables, se dispondrán de las mismas reglas para el uso de atributos que se declaren de los objetos.

  • Ejemplos:

1.- int variable = 0;

2.- /// Explicacion de la variableLarga



int variableLarga;

    1. Constantes

  • De la misma manera que las variables, los nombres de las constantes deberán dar su significado por si solo.

  • En cuanto a la escritura del nombre de las constantes, los mismos estarán escritos en mayúsculas completamente, y en el caso de que contengan más de una palabra, éstas se separarán con el carácter ‘_’.

  • Ejemplos:

1.- const int CTE = 0;

2.- /// Explicacion de la constante



const int UNA_CONSTANTE = 15;

    1. Indentación

Para la indentación se utilizará una indentación de cuatro espacios para todas las estructuras de control de flujo. Sobre estas estructuras, también se debe especificar que el uso de llaves será como muestra el ejemplo así como también las llaves e indentación para la implementación de clases y tipos. También cabe aclarar que el uso de líneas en blanco permite tener una visión clara del código, por lo cual se utilizarán para separar distintas declaraciones de métodos, propiedades, atributos, constantes, etc.

Ejemplo:


1.- class UnaClase

{

private int atributo;



public UnaClase()

{

atributo = 0;



}

public int sumar(int[] conjuntoNumeros)

{

///

Esta función suma



/// en atributo todos los numeros

/// en conjuntoNumeros

///
Conjunto

/// de numeros a sumar


foreach(int numero in conjuntoNumeros)

{

atributo += numero;



}

return atributo;

}

}

En cuanto a los comentarios explicativos de cada estructura de control de flujo, se deberán colocar en la primera línea luego de las llaves.



    1. Propiedades

  • En lo que refiere a propiedades, éstas se deben nombrar con el mismo nombre de los atributos a los que se refiere, excepto que el nombre de una propiedad debe comenzar con mayúscula utilizando también mixed-case.

  • Ejemplos:

1.- public int Propiedad

{

get

{

return propiedad;

}

}



2.- public int Propiedad

{

get



{

/// Explicacion de la propiedad

return propiedad;

}

set



{

propiedad = value;

}

}


  1. Otros

Los nombres de las clases se regirán por las mismas reglas de nombres que las variables, con la salvedad que estos nombres deberán comenzar con mayúscula.

En cuánto a la declaración de métodos, sus nombres deben seguir las mismas reglas que las variables.



Respecto a los nombres de los archivos, las interfaces deberán comenzar con la letra ‘I’, mayúscula.

Estándar de Implementación Página de



Compartir con tus amigos:


La base de datos está protegida por derechos de autor ©odont.info 2019
enviar mensaje

    Página principal