Documentação para softwares feito em Assembly

[caiortp]

Boa Tarde pessoal! sou novo por aqui,

Então, estou trabalhando agora com assembly, só que encontrei alguns códigos sem comentários e agora há a necessidade de documenta-los.
Gostaria de saber se alguem conhece um padrão (tipo UML para O.O) para documentar pode ter o documento destes softwares padronizados.

Usamos fluxograma(padrão) e diagrama em blocos, mas alguém sabe se existe um certo padrão para este tipo de documentação?



Valeu!!
abraços



Caio Pereira

[Emerson]

Caio,

Eu costumo usar diagrama em blocos e diagrama hierárquico de funções, no seu caso será de rotinas e subrotinas. O diagrama em blocos é mais detalhado, já o diagrama hierárquico de funções é mais macro, ou seja, relaciona apenas as chamadas de funções (subrotinas) e os parâmetros de entrada e saída da mesma. No link abaixo você encontrará algumas informações básicas sobre esse tipo de diagrama:

http://www.inf.puc-rio.br/~pedro/INF1342/PS-DHF.pdf


Até mais

Emerson

[Renie]

Olá Caio!

Diagrama de blocos e/ou hierárquico e Fluxograma são ótimas ferramentas de documentação, mas, em se tratanto de assembly,
comentar ao máximo o código é primordial!

O Diagrama de blocos e/ou hierárquico são muito úteis para a
apresentação dos enfoques principais do problema, tanto para
um chefe, um cliente, quanto para um novo mantenedor.

O Fluxograma geralmente é voltado a auxiliar o mantenedor a
localizar mais facilmente os pontos de ajustes com, dar uma
visão mais detalhada a novos mantenedores.

Porém, em assembly (em linguagens de alto nível também!), um
código bem comentado pode agilizar uma manutenção corretiva
ou evolutiva drasticamente.

Dependendo da disponibilidade de pessoal e tempo para documentar
um aplicativo, sistema ou rotinas, nem sempre é possível ter-se
diagramas e fluxos ou objetos de outras ferramentas (em muitos
casos, ou produz-se ou documenta-se!), um código bem comentado
é a bóia de salvação, e pode ser usado posteriormente para montar
as documentações quando houver disponibilidade mais propícia.

[andre_luis]

Olá Caio!
Diagrama de blocos e/ou hierárquico e Fluxograma são ótimas ferramentas de documentação, mas, em se tratanto de assembly. Comentar ao máximo o código é primordial!

Concordo com o Renie, pois - ao contrário da linguagem C - o assembly não é uma linguagem estruturada, e dependendo de como o programa foi feito ( com poucas rotinas dedicadas ) , pode ser muito complicado documentar o funcionamento do programa.

+++

[pbernardi]

E, na minha opinião, dependendo do programa é mais fácil reescrevê-lo do que entendê-lo.

Principalmente se não for documentado.

[loser_13]

concordo com voce , as vezes o cara programa de um jeito que so ele mesmo pra desvendar oque faz aquele monte de código.

Falou

[Paulo]

Os programadores/desenvolvedores devem aprender que software não é apenas o código executável (.exe, .bin, .hex, .s19, etc, não importa), mas sim um conjunto de coisas, para isso ele deveria estudar um pouco sobre engenharia de sistemas de software, daí ele veria que um software é composto de vários documentos e não apenas o código fonte do programa, daí ficaria mais fácil trabalhar, ainda mais no caso quando se pega um software feito por outra pessoa que não está no momento para te explicar o que aquilo faz, daí fica muito difícil.

Até +...
Paulo D.

[caiortp]

Boa Tarde pessoal,

Pessoal obrigado pela ajuda, eu vi que estou no caminho certo mesmo..... agora deixa o estagiario aqui ralar pra documentar as milhares de linhas... rsrsrs vai levar bastante tempo!!!

Emerson, obrigado pelo link!!


abraços