papellog

Departamento de Ciencias e Ingeniería de la Computación
Academia de Ciencias de la Computación
Autor: M. en C. Edgardo Adrián Franco Martínez 

Unidad I "Conceptos básicos y herramientas de
programación"
1.7 Documentación y estilos para escribir código
Estructuras de datos (Prof. Edgardo A. Franco)

1

• Software
• Ingeniería del software
• Ciclo de vida del software
•Documentación de software
• Documentación externa
• Documentación interna

Algoritmia  y programación estructurada
1.7 Documentación y estilos para escribir código
Autor: M. en C. Edgardo Adrián Franco Martínez

Contenido

• Código autodocumentado
• Comentarios efectivos
• Técnicas para comentar código
2

• Comúnmente se asocia el termino Software se
asocia con Programa de computadora. Sinembrago
una definición más adecuada dentro del contexto
de la ingeniería en sistemas computacionales sería:
Programa de computadora y la documentación 
asociada a este. [Ian Sommerville, 2005]
• Nota: Los productos de software se pueden
desarrollarse para algún cliente en particular o para
un mercado general.

Algoritmia  y programación estructurada1.7 Documentación y estilos para escribir código
Autor: M. en C. Edgardo Adrián Franco Martínez

Software

3

• La ingeniería del software es un disciplina de
ingeniería que comprende todos los aspectos de la
producción de software.
• ¿Cuál es la diferencia entre ingeniería de software
y ciencia de la computación?

Algoritmia  y programación estructurada
1.7 Documentación y estilos para escribir códigoAutor: M. en C. Edgardo Adrián Franco Martínez

Ingeniería del software

• La ciencia de la computación comprende la teoría y
los fundamentos; la ingeniería de software
comprende las formas practicas para desarrollar y
entregar un software útil.
4

• La ingeniería de sistemas se refiere a todos los
aspectos del desarrollo de sistemas informáticos,
incluyendo hardware, software e ingeniería de
procesos. Laingeniería de software es parte de este
proceso

Algoritmia  y programación estructurada
1.7 Documentación y estilos para escribir código
Autor: M. en C. Edgardo Adrián Franco Martínez

• ¿Cuál es la diferencia entre ingeniería de software
e ingeniería de sistemas?

5

Algoritmia  y programación estructurada
1.7 Documentación y estilos para escribir códigoAutor: M. en C. Edgardo Adrián Franco Martínez

Ciclo de vida del software

6

• Se solicitan y recopilan los requerimientos y
necesidades a satisfacer.

Algoritmia  y programación estructurada
1.7 Documentación y estilos para escribir código
Autor: M. en C. Edgardo Adrián Franco Martínez

Definición de necesidades
• Los clientes e ingenieros definen el software a
producir y las restricciones de su operación.

7Algoritmia  y programación estructurada
1.7 Documentación y estilos para escribir código
Autor: M. en C. Edgardo Adrián Franco Martínez

Análisis
• Con base en las necesidades considerar
restricciones, flujo y procesamiento de la
información así como las arquitecturas y tecnologías
más adecuadas para su construcción.

8

Algoritmia  y programación estructurada1.7 Documentación y estilos para escribir código
Autor: M. en C. Edgardo Adrián Franco Martínez

Diseño
• Construcción del sistema en papel, incluyendo toda
la documentación y representaciones graficas
necesarias para construir el software por un equipo
de trabajo.

9

Algoritmia  y programación estructurada
1.7 Documentación y estilos para escribir código
Autor: M. en C. Edgardo Adrián Franco MartínezCodificación
• Implementar el diseño apoyándose de las
herramientas de programación necesarias.
• Es importante que conforme la codificación va
avanzando, se documente en el la relación
codificación‐diseño.

10

Algoritmia  y programación estructurada
1.7 Documentación y estilos para escribir código
Autor: M. en C. Edgardo Adrián Franco Martínez

Pruebas
• Las...