Olá Pessoas do Fórum,
No que consiste a documentação do EP1 ?
Basta apenas comentar o código-fonte dizendo oq faz cada método ? Ou é preciso redigir um trabalho à parte sobre o que vc usou do OpenGL ?
T+ !
Oi Silvia,
eu me referia mais ao código, e a qualquer outra informação necessária para poder compilá-lo e executá-lo, caso fuja da especificação, ou você acredite que mereça "comentário".
Basicamente, programas devem ser entendidos não só por computadores mas também, e principalmente, por pobres seres humanos, como seu professor e monitor. Se você está à procura de sugestões sobre como endentar o seu programa, elas podem ser encontradas nas páginas Leiaute (= layout) e Documentação escritas pelo Prof. Paulo Feofiloff.
eu me referia mais ao código, e a qualquer outra informação necessária para poder compilá-lo e executá-lo, caso fuja da especificação, ou você acredite que mereça "comentário".
Basicamente, programas devem ser entendidos não só por computadores mas também, e principalmente, por pobres seres humanos, como seu professor e monitor. Se você está à procura de sugestões sobre como endentar o seu programa, elas podem ser encontradas nas páginas Leiaute (= layout) e Documentação escritas pelo Prof. Paulo Feofiloff.
Interessante estas sugestões escritas pelo Prof. Feofiloff.
Só para acrescentar:
Comentários no meio do código cheiram a refatoração:
http://wiki.java.net/bin/view/People/SmellsToRefactorings
(o que é refatoração: http://www.refactoring.com/)
A indústria tem bons exemplos de boa documentação. A própria API do java é uma (o que é alcançado através do javadoc).
Só para acrescentar:
Comentários no meio do código cheiram a refatoração:
http://wiki.java.net/bin/view/People/SmellsToRefactorings
(o que é refatoração: http://www.refactoring.com/)
A indústria tem bons exemplos de boa documentação. A própria API do java é uma (o que é alcançado através do javadoc).