Documentacion De Codigo Y Convenciones

INGENIERIA DE SOFTWARE II.

PROFESOR : IVAN R. CHENOWETH.

ACTIVIDAD: DOCUMENTACION DE CODIGO Y CONVENCIONES.

ALUMNO: MORENO VIDAL MANUEL HUMBERTO.

GRUPO: SI 5-1.

HERMOSILLO SONORA A 02 DE FEBRERO DEL 2013.

INTRODUCCION.

En el presente documento se plantean palabras y procesos de lenguajes de programación como lo son JAVA, PHP, C++, NET Y PHYTON.
Se plantean los pasos másimportantes para iniciar a crear programas con dichos lenguajes además de mencionar las principales condiciones que deben cumplirse para obtener programas con códigos eficientes , completos y documentarlos correctamente.

NOMBRADO DE VARIABLES EN JAVASCRIPT.
En JavaScript las variables se crean con la declaración var, atribuyéndole incluso ningún valor, o simplemente en el acto de asignación de unvalor (por ejemplo, x=15 crea automáticamente una variable numérica). La declaración var en más variables se debe repetir para cada una, o bien debe efectuarse con una interrupción de línea:
var micarácter
   mivariable;
NOMBRADO DE METODOS EN JAVASCRIPT.
La primer letra debe ser minúscula si son mas de 2 palabras se usa la notación de Camello, sin dejar de poner la primer letra minúscula (enel caso de los métodos) Los nombres regularmente son verbo-sustantivo (El verbo en infinitivo). Ejemplo: getNombre, setNombre, isHumano, addListener, removePersona 
*En este caso se esta revolviendo ingles con español para seguir los estándares de losJavaBeans pero de igual forma los siguientes ejemplos son correctos: quitarBoton, calcularCredito, etc.
NOMBRADO DE CONSTANTES.
Son creadas usandolos modificadores static final y se debe utilizar solo mayúsculas, si son 2 palabras o mas se separan mediante guion bajo "_" Ejemplo: MI_CONSTANTE, PESO_MIN, etc.
DOCUMENTACION EN JAVASCRIPT.
El paquete de desarrollo Java incluye una herramienta, javadoc, para generar un conjunto de páginas web a partir de los ficheros de código. Esta herramienta toma en consideración algunos comentarios paragenerar una documentación bien presentada de clases y componentes de clases (variables y métodos).
. Se dice que javadoc se centra en la interfaz (API - Application Programming Interface) de las clases y paquetes Java.
Javadoc realza algunos comentarios, de los que exige una sintaxis especial. Deben comenzar por "/**" y terminar por "*/", incluyendo una descripción y algunas etiquetas IDENTACION EN JAVASCRIPT.
Deben tomarse 4 espacios como unidad de indentación. La construcción exacta de la indentación (espacios o tabuladores) no es crítica. Los tabuladores deben estar fijados exactamente cada 8 espacios (no cada 4).
Longitud De Líneas.
Se deben evitar líneas de más de 80 caracteres, porque sino no son manejadas correctamente por muchos terminales y herramientas.
Los ejemplos deuso en la documentación deben ir en líneas más cortas, generalmente de no más de 70 caracteres.
Corte De Líneas.
Cuando una expresión no cabe en una sola línea, debe saltarse a la siguiente línea de acuerdo con los siguientes principios generales:
Saltar después de una coma
Saltar antes de un operador
Son preferibles los saltos de alto nivel a los de bajo nivel
Alineas la nueva línea con elinicio de la expresión del mismo nivel de la línea inmediatamente anterior
Si las anteriores reglas dejan el código confuso, o demasiado compactado sobre el margen derecho, se colocarán indentaciones de 8 espacios en su lugar.
NOMBRADO DE VARIABLES EN C++.
En C, los nombres de las variables de deben ajustar a las siguientes reglas:
1. El nombre puede contener letras, dígitos y el carácterde subrayado.
2. El primer carácter del nombre debe ser una letra. El carácter de subrayado también es un carácter inicial válido.
3. Tiene importancia el uso de mayúsculas y minúsculas. Por lo tanto, los nombres “contador” y “Contador” hacen referencia a variables diferentes.
4. Las palabras reservadas del C no pueden usarse como nombres de variables.

NOMBRADO DE METODOS EN C++....