estilo_e_documentacao

estilo_e_documentacao - Estilo e Documentao de Programas ca...

Info iconThis preview shows pages 1–2. Sign up to view the full content.

View Full Document Right Arrow Icon
Estilo e Documenta¸ ao de Programas Bacharelado em Ciˆ encia da Computa¸ ao Prof a . Katti Faceli Prof a . Tiemi Christine Sakata 1 Introdu¸c˜ ao Este documento dever´ a ser utilizado pelos alunos das disciplinas de Estruturas de Dados I e Programa¸ ao Orientada ` a Objetos como guia no desenvolvimento dos projetos. O uso de um bom estilo de programa¸ ao e da documenta¸ ao apresentada a seguir s˜ao componentes da nota do trabalho. 2 Documenta¸ ao Todo programa deve ser devidamente documentado. A documenta¸ ao interna facilita o entendimento do odigo e a documenta¸ ao externa esclarece o funcionamento do programa. 2.1 Documenta¸ ao interna A documenta¸ ao interna ´ e constitu´ ıda de coment´ arios inseridos em seu c´ odigo. Os coment´ arios devem estar em pontos estrat´ egicos, presentes em todas as partes onde a execu¸ ao do programa n˜ ao seja descrita de forma trivial ou onde o papel de alguma vari´avel n˜ ao seja de compreens˜ ao imediata. N˜ ao comente o ´ obvio. Al´ em disto, vocˆ e deve seguir um bom estilo de programa¸ ao, como discutido em aula. Veja os slides e sites recomendados, escolha seu padr˜ ao e siga-o em todos os trabalhos das duas disciplinas. Inicialmente, o programa deve conter as seguintes informa¸
Background image of page 1

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Image of page 2
This is the end of the preview. Sign up to access the rest of the document.

This note was uploaded on 09/12/2011 for the course DPQ 09 taught by Professor Johncarpenter during the Spring '08 term at UFSCar.

Page1 / 3

estilo_e_documentacao - Estilo e Documentao de Programas ca...

This preview shows document pages 1 - 2. Sign up to view the full document.

View Full Document Right Arrow Icon
Ask a homework question - tutors are online