Documentacin y estilos para escribir cdigo

Software
Programa de computadora y la documentacin asociada a este. Los productos de software se pueden desarrollarse para algn cliente en particular o para un mercado general.
Ingeniera del software
La ingeniera del software es un disciplina de ingeniera
que comprende todos los aspectos de la produccin de
software.
La diferencia entre ingeniera de software y ciencia de la
computacin es que La ciencia de la computacin comprende
la teora y los fundamentos; la ingeniera de software
comprende las formas practicas para desarrollar y entregar
un software til.
La diferencia entre ingeniera de software e ingeniera de
sistemas es que La ingeniera de sistemas se refiere a todos los
aspectos del desarrollo de sistemas informticos, incluyendo
hardware, software e ingeniera de procesos. La ingeniera de
software es parte de este proceso
Ciclo de vida del software
Definicin de necesidades
Los clientes e ingenieros definen el software a producir y las restricciones de su operacin.
Se solicitan y recopilan los requerimientos y necesidades a satisfacer.
Anlisis
Con base en las necesidades considerar restricciones, flujo y procesamiento de
la informacin as como las arquitecturas y tecnologas ms adecuadas para su
construccin.
Diseo
Construccin del sistema en papel, incluyendo toda la documentacin y
representaciones graficas necesarias para construir el software por un equipo
de trabajo.
[no text]
Implementar el diseo apoyndose de las herramientas de programacin necesarias.
Es importante que conforme la codificacin va avanzando, se documente en el la relacin codificacin-diseo.
Pruebas
Las pruebas de software, son los procesos que permiten verificar y revelar la calidad de un producto
software. Son utilizadas para identificar posibles fallos de implementacin, calidad, o usabilidad de un
programa.
Validacin
[no text]
Mantenimiento y evolucin
El mantenimiento del software contempla la modificacin de un producto de software despus de la
entrega para corregir averas, para mejorar funcionamiento u otras cualidades, o para adaptar el
producto a nuevas utilidades y funciones.
Documentacin de software
Documentacin externa
Copia de los requerimientos, copia del algoritmo empleado as como
de las alternativas consideradas, diagramas de flujo, copia de los
documentos que se utilizan para el diseo de las entradas y salidas
visuales o impresas, copia de los estndares de desarrollo, listado
ms actual del cdigo fuente, documentos relacionados con las
modificaciones hechas al proyecto, as como notas importantes de
diseo usadas por los desarrolladores durante el diseo y la
implementacin, entre otras.
Documentacin interna
Facilita grandemente la lectura y comprensin del
cdigo, tanto para el propio programador como para
todos los que necesiten leerlo, y es especialmente til
en las fases de prueba y mantenimiento de los
programas.
La documentacin --al igual que el
diseo-- es una marca del orgullo
profesional que el programador
pone en sus creaciones.
Cdigo autodocumentado
Para que el cdigo sea explicativo necesita que
se cumplan sus funciones, sus variables y tenga
un buen fluido del programa.
Comentarios efectivos
Los comentarios errneos al cdigo pueden
confundir a sus lectores, incluso si el cdigo se
ha escrito usando un buen estilo de
programacin. El cdigo con este tipo de
comentario es peor que el cdigo sin
comentarios. Por otro lado, si los comentarios
son correctos pero slo repiten verbosamente
las sentencias de cdigo, no aaden valor al
cdigo mismo.
Tcnicas para comentar cdigo
Comentarios por bloques: comentarios de
una o dos lneas que describan bloques de
cdigo.
Escribe comentarios que describan la intencin
del cdigo: en lugar de repetir el cdigo, escribir
comentarios que describen el propsito del cdigo.
Enfoca tus esfuerzos de documentacin en el
cdigo mismo: el cdigo mismo debera ser la mejor
documentacin.
Enfoca el comentario del bloque en el por qu en lugar
del cmo: los comentarios que explican cmo se hace
algo estn a un nivel de programacin, algo tcnicos, en
lugar de estar a nivel del problema.
Evita las abreviaturas: los comentarios no deben
ser ambiguos, sino fcilmente legibles sin el
trabajo de adivinar abreviaturas.
Documenta las sorpresas: si hay lago que no es obvio a partir del
cdigo mismo. Cada truco tcnico que se use debera ser
comentado.