Universidad de Talca Facultad de Ingeniería Campus Los Niches Curicó. ESTANDAR DE PROGRAMACION C#

Transcripción

1 Universidad de Talca Facultad de Ingeniería Campus Los Niches Curicó. ESTANDAR DE PROGRAMACION C#

2 INTRODUCCIÓN El uso de un estándar de programación o codificación estándar, es de gran relevancia, al momento de entregar un producto de software, lo cual repercute en la calidad de éste. El uso de un estándar de programación permite mejorar la práctica, elusión de problemas (ambigüedad) en el código, logrando un conocimiento y un seguimiento más fácil para el equipo de desarrollo. En este documento se da a conocer un estándar de codificación orientado principalmente al lenguaje de programación C#, el cual es uno de los utilizados, por Adobe Flex, para el diseño de aplicaciones dinámicas Web. Este documento será entregado a cada líder, él cual distribuirá copias a los diferentes miembros de su grupo, de manera que todos puedan codificar de manera convencional. 2

3 1. Qué es Adobe Flex? Adobe Flex es un marco de trabajo que agrupa una serie de tecnologías para dar soporte al despliegue y desarrollo de Aplicaciones enriquecidas de internet, basadas en su plataforma propietaria Flash. 2. Codificación Estándar CSharp. En éste documento se detalla un estándar para CSharp, un lenguaje bastante conocido por el equipo de trabajo, facilitando asi el trabajo al momento de codificar y lograr buenas practicas de programación. 2.1 Controles. Esta tabla muestran los prefijos que deben llevar los nombres de los elementos de control más usados. Sintaxis: prefijo_nombre - Prefijo: abreviación del tipo de control - Nombre: nombre dado a un determinado control. La letra de cada palabra debe ser mayúscula. Por ejemplo, si se usa el control Text, en el cual se ingresa nombre usuario, el nombre del control debe ser asi: txt_nombreusuario donde cada primera letra de la palabra correspondiente deber ir en mayúscula. 3

4 Tabla de controles. Control Prefijo Alert alt Button btn ButtonBar btb Checkbox chk ColorPicker clp DataChooser dtc DataField dtf DataGrid dtg FileSystemComboBox fsc FileSystemDataGrid fsd FileSystemList fsl FormItemLabel fil HorizontalList htl HRule hrl HSlider hsl HSrollBar hsb Image Img Label lbl LinkBar lkb LinkButton lbt List lst Menu mnu MenuBar mnb NavBar nvr PopUpButton pub PopUpMenuButton pmb ProgressBar prb ProgressBarDirection pbd ProgressBarMode pbm RadioButton rbt RadioButtonGroup rbg RitchTextEditor rte Spacer spc TabBar tbr Text txt 4

5 TextArea TextInput TileList ToolTip Tree VRule VScrollBar VSlider txa txi tlt tlp tre vrl vsb vsl Controles: Fuente: 2.2 Estilos de codificación Reglas y recomendaciones en general a) No incluir en el nombre de la variable el tipo de datos. a. Incorrecto: public void metodo(double doublevalue) b. Correcto: public void metodo(double valor) b) Prefijo de interfaces. a. Usar I como letra capital en el nombre de la interfaz: Ejemplo: INombreInterface, donde NombreInterface es el nombre de la interfaz. 5

6 c) Usar nombres singulares para enumeracion, ej: public enum Pais Chile, Argentina, Perú, Bolivia Se puede visualizar que Pais, es singular. d) No usar letras semejantes a digitos, Ej: //IO, letras ele minuscula, o mayuscula. Int lo; If (lo == 10) El usar letras parecidas a dígitos, genera ambigüedad en las variables. e) Usar verbos en gerundio para eventos. Ej: public event ClosingEventHandler Closing; Closing, es un evento del tipo ClosingEventHandler. f) Cada primera letra de cada palabra del método debe ser mayúscula, Ej: public int CalcularRaizCuadrada(double value) 6

7 g) Los nombres del tipo de acceso(public, private, protected), deben estar presentes en cada método(antes)y deben ser en minúscula, Ej: Incorrecto: boolean Salir(int value) Correcto: public boolean Salir(int value) h) Formato de comentarios. - Usar /// para comentar en un renglón, Ej: ///comentario - Para comentarios más amplios, usar el siguiente formato, Ej: /* comentario 1 * comentario 2 * comentario 3 *... * comentario n */ i) No repetir el mismo nombre para diferentes tipos de datos, es decir. int numero= valor; boolean otrovalor; If(otroValor) double numero=3.1416; 7

8 j) Comentar cada método, acerca de su función y el valor de retorno, Ej: ///Retorna el largo de un string, cadena de caracteres. public int LargoCadena(string cadena) k) Inclusión de espacios en la codificación, Ej: Incorrecto int suma=0; for(int i=0;i<100;i++) suma+=2*i; Correcto. int suma = 0; for( int i = 0; i < 100; i++) Suma += 2 * i; Control de flujo, Condiciones General a) Actualizar variables fuera del ciclo, for. b) Los controles de flujos convencionales (if, else,switch for, while,do while) debe estar precedida de un bloque de código, según lo siguiente: 8

9 if(valor) ///bloque de código c) Indentación. Se debe indentar, según el siguiente formato. int valor=0,multiplotres=0; While(valor < N) if(valor % 3 == 0) multiplotres++; else ///otra cosa valor++; *atención, con la ubicación de los d) No crear comparaciones explicitas para true o false Por Ej: bolean valor = true; if(valor == true) Se puede observar que la comparación en el if es innecesaria. 9

10 Correcto: bolean valor = true; if(valor) Recomendaciones a) No definir redundancia en índices, Ej; arreglo[i]=++c; ///correcto arreglo[i]=++i; ///incorrecto, usar arreglo[++i] j=++j + 1///incorrecto, Usar j += 2 i++; /// en lugar de i=i+1; b) Expresión directa propia del lenguaje: TipoDato z = x comparacion y? a : b Comparación: <,>,<=,>=,! 10

11 Explicación: z tendrá el valor de a, si la comparación entre x e y es verdadera, en caso contrario z, contendrá el valor de b, Ej.: Int x = 4; Int y = 1; boolean z = x > y? true : false En este caso z, será true. c) Mejor forma de inicialización, especialmente para variables booleanas. ///situación boolean a; a = (valor < 10); ///mejor codificación, en una línea boolean a = (valor < 10); Programación orientada a objeto. La idea es trabajar bajos los conceptos de orientación a objetos, es decir: a) Definir clases abstractas b) Trabajar con Herencia, Polimorfismo, Encapsulamiento c) Si es posible definir Interfaces Excepciones Son sentencias que controlan por lo general los errores. a) No abusar de Exception, sino usar otros tipos de excepciones mas especificas(sqlexception, IOException, IndexOutOfRangeException), por Ej: 11

12 try catch(sqlexception ex) System.console.write(ex.Message);///mensaje que informa sobre el error. ///controla excepciones de conexión con base de datos. b) El nombre de la variable del tipo de Excepción, debe incluir las primeras letras de cada palabra del tipo de Excepcion, junto a ex por ej: ArgumentException a_ex; ArgumentNullExp an_ex; SqlException s_ex; Fuente: 12

13 3. CONCLUSION Se ha detallado un estándar de forma general de codificación de CSharp, como lenguaje de programación incluido en Flex, con la finalidad de lograr buenas prácticas de codificación común para el equipo de trabajo. 13