Buenas Prácticas - PupiUTN/proyecto-final GitHub Wiki

                                    Buenas Prácticas Generales

Elementos

  1. Paquetes

El prefijo del nombre de los paquetes debe respetar la convención "Lower case" y debe ser uno de los nombres de dominio de alto nivel (com, edu, gov, net)Los subsecuentes componentes del nombre del paquete varían de acuerdo a las convenciones de nombres internas de cada organización.

Ejemplo:

package com.sun.eng; package com.apple.quicktime.v2; org.wikipedia.

2.Clases e interfaces

Los nombres de las clases e interfaces deben ser sustantivos y respetar la convención "Pascal case".Evitar usar abreviaturas a no ser que la abreviatura sea mas conocida como URL o HTML

Ejemplo:

public class ImageSprite{} public interface RasterDelegate {} public interface Printeable

3.Métodos
El nombre de los métodos deben ser verbos y respetar la convención "Camel case"

Ejemplo:

public void fillPolygon() {}, public void fillPolygon() {}

4.Variables
El nombre de todas las variables debe respetar la convención "Camel case". Los nombres de variables no deben empezar con guion bajo o el signo dolar. Los nombres de variables deben ser cortos pero significativos, se deben evitar nombres, de un solo carácter, excepto para variables de índices temporales. Nombres comunes para variables temporales son i, j, k, m, y n para enteros; c, d, y e para caracteres.

Ejemplo:

int i; char c; String gameTitle;

5.Constantes

El nombre de todas las constantes debe respetar la convención "Upper case". En caso de existir mas de una palabra, estas serán separadas por un guion bajo. Ejemplo:

final float PI = 3.14; final float WINDOW_SCALE = 2;

6.Idioma

Todos los nombres deberían escribirse en inglés.

Ejemplo:

fileName; // NOT: filNavn

7.Branches

nombre#numero

Ejemplo: comprar-plantilla#171

https://help.github.com/articles/closing-issues-using-keywords/

  1. Convenciones Nombres

Entidades: singular

Controllers: plural

FontEnd: todo plural

  1. OTROS Para mas referencias referirse a google drive