Como gerar a documentação do sistema ?

[Vlademiro]

Pessoal, alguém conhece uma ferramenta para ler o código fonte de um sistema e gerar a documentação do mesmo. Vi que o harbour tem o hbdoc, mas não consegui gerar a documentação. Procurei na NET e não encontrei nada ensinando a usar o hbdoc e na pasta do mesmo não tem sequer um LEIAME. :(Neg

Andei testando o doxygen, mas ele não gera documentação para harbour, apenas gera um site com o código fonte do meu sistema, eu quero uma que leia os comentários que tem nas funções e gere arquivos a parte com a documentação necessária.

[rochinha]

Amiguinho,

Dependendo de como seria esta documentação voce pode verificar como funciona o Visustin e o DBFDoc.

Aliando estas duas ferramentas voce pode criar documentação de trabalho.

Uma ferramenta CASE lhe cairia bem mas muitas, boas por sinal, não dão suporte direto a .DBF.

[Vlademiro]

Ontem finalmente descobri uma ferramenta boa : robodoc , tem para windows e linux e ela lê os comentários no código fonte e gera uma documentação em html. )

Para banco de dados postgresql tem a pgdoc que é em perl e gera um html com todas as tabelas, relacionamentos, triggers, etc.

Eu usava a ferramenta doxygen, ela é muito boa, mas somente para linguagens estilo C, como Java,C++, PHP e outras. Mas ela não funciona com a linguagem clipper/harbour.

Todas são software livre.

O hbdoc não extrai direto do prg, inclusive no fonte dela está fixo a extensão txt.

[Vlademiro]

Rochinha, visustin eu já conhecia, mas esse DBFDoc parece ser uma boa opção também!

Obrigado!
:xau

[lugab]

Vlademiro, posta o link desse Robodoc ai, pra todo mundo conhecer

Ontem finalmente descobri uma ferramenta boa : robodoc , tem para windows e linux e ela lê os

[Vlademiro]

O link é : http://rfsber.home.xs4all.nl/Robo/

Aqui tem alguns exemplos : http://rfsber.home.xs4all.nl/Robo/manual.html#id2488992

Para baixar tem os fontes para serem compilados ou se preferir um binário para windows.

A ferramenta é simples e eficiênte.

[Vlademiro]

Deixa eu acrescentar um exemplo.

Nas suas funções, vc deve documentar assim :

Nota que a primeira linha tem /****f* gestor.configurador/Main

O f significa que é função e gestor.configurador é o grupo/subgrupo da função

/Main é o nome da função

/****f* gestor.configurador/Main
* NAME
* MAIN -- Rotina de entrada do sistema
* SYNOPSIS
* MAIN( wOPC )
* FUNCTION
* Procedure inicial. Ela tem os seguinte objetivos :
* (1) Receber o parâmetro wOPC da linha de comando e dire-
* cionar para a ação apropriada.
* (2) Iniciar as variáveis globais do sistema
* (3) Montar o menu principal de acordo com o valor de wOPC
* INPUTS
* wOPC - Valor da linha de comando. Ele pode assumir:
* /config : Se for para reconfigurar os
* arquivos.
* N : Onde N é um número representando
* o módulo (conjunto de rotinas) do
* menu principal. Por exemplo, se
* N = 1 o sistema irá apresentar o
* módulo de caixa.
* RESULT
* Sempre retorna NIL
*
* EXAMPLE
* No prompt do sistema : ./gestor0004 1
* SEE ALSO
* popup(), config(), indexa(), manusu(), chamaRotina(), telaPadrao(),
* DesenhaMenu()
******
* Aqui escreva o que vc quiser que não aparecerá no PDF ou HTML gerado pelo robodoc
*/

Para gerar faça assim :

robodoc --src /home/vla/gestor/frm --doc /var/www/robodoc --multidoc --html --charset UTF-8 --index --source_line_numbers --syntaxcolors

--src <<< Pasta com os fontes
--doc <<< Pasta onde será gerado os fontes
--multidoc << Vários documentos
--html << Formato HTML (tem PDF tb!!)
--charset

Pronto, agora é só documentar as funções corretamente e o robodoc irá gerar um "site" com a documentação das suas funções.
Isso é importante pois a gente vai criando rotinas e acaba deixando a documentação de lado. Com o robodoc vc precisa somente documentar o seu código fonte que ele faz o resto.