como documentar projeto ?

Edcronos

24-11-2015 16:57:07

Qual a melhor forma de documentar o que cada parte de um planilha faz?

eu estou perdendo o controle da minha planilha
as partes individuais até dá para saber

mas a maior parte trabalha em conjunto com outras partes
e o pior é que tem macros que é multi uso e trabalha com varias outras macros mas não são macros de controle e são de pouco uso

em um caso desse onde a macro é incrementada com outras, como documentar o uso ?
e o projeto muda constantemente
e ainda tem as formatações e formulas que tem um uso primordial

no momento ainda estou no controle da base que usa variaveis publicas para se comunicar
issso de certa forma me forçou a ter um padrão

tipo Ci =coluna inicial, Li =linha inicial,

Public nST As String '---------------indica Nome do Setor
Public nSTo As String '--------------indica Nome do Setor de ORIGEM
Public Not_Setor As Long '-----------retorna que setor não existe
Public Naba As String '-----------indica Nome da aba origem

mas as macros que fiz por força da inspiração do momento a maioria já perdi o controle,
isso por que faço muito rapido e apenas para testar, mas um monte tem bons uso

e agora estou querendo fazer umas mudanças radicais " se a preguiça deixar "
e quero adicionar uma descrição do funcionamento de cada parte "claro que apenas para uso proprio"

tipo a macro que desloca os valores dentro do setor
sobe e desce, direita e esquerda,
se o seletor estiver acionado e a celula ativa pertencer ao setor que está movendo ela move apenas a linha ou coluna selecionada
entre outras coisas adicionadas na mesma categoria, isso para alinhar os dados para analise visual e ação de macros

isso possibilitou entre outras coisas gerar gráficos de ações em períodos análogos de interferência entre si

mas para passar isso a frente eu tenho que descrever o uso
claro que a maior parte do projeto vou colocar em C++

webmaster

24-11-2015 18:15:47

Edcronos,

Na minha experiência, pude concluir que o VBA está bastante atrasado neste quesito. Existem algumas tentativas de melhorar isso:

http://dailydoseofexcel.com/archives/20 ... -visustin/
https://www.add-ins.com/macro-products- ... r-code.htm

Entretanto, há um grande esforço da Microsoft para migrar o desenvolvimento de aplicações baseadas em Office para o .NET e recentemente para o Javascript! Claro, tudo isso debaixo do Visual Studio, que já conta com mecanismos de documentação pra lá de poderosos.

Att

Edcronos

24-11-2015 19:17:11

ola tomas parece que são programas pagos,
e como o excel vba não me gera renda não fico animado em gastar

atualmente eu mantenho o controle separando as macro por tipo de uso em modulos

mas como eu escrevo mais por impulso do que por motivação já baguncei tudo
a maioria das macros eu sei oq faz só em olhar o codigo

mas tem algumas que fiz por alguma ideia de momento e como não usei acabou ficando de lado
e as vezes são umas ideias bem malucas, funcionais, mas malucas
o pior...
algumas eu incorporei o uso em macros que uso frequentemente e muitas tem chamadas de mais de 4 macros em sequencia

quero passar a limpo
mas não sei como descrever o uso e mapear as chamadas das outros macros,
ainda mais que vira e volta eu modifico ou adiciono algumas coisas

comentar enquanto escrevo o codigo é impossivel,
pq escrevo por impulso e muitas vezes sem um objetivo e apenas para adicionar algo nas macros que já tenho

vc deve ter algum tipo de esboço de comentário para projetos que tem muitas chamadas encadeadas e ainda sem definição de completado
se pude mostrar um exemplo

Edcronos

24-11-2015 19:48:22

fui fazer um teste do visustin em uma de minhas macro que nem é tão complexa
mas o resultado "nossa"

não vejo em que isso pode ser util

webmaster

25-11-2015 11:33:50

Edcronos,

A documentação nunca é útil para quem está programando. Ela será útil para manutenções futuras, quando olhar aquele bloco de código fora de contexto e não fizer sentido algum.

E claro, nada substitui clareza de código, desde a nomeação de variáveis até sua organização, o que em muitos casos envolve gosto pessoal.

Sim, o assunto é bem polêmico e gera toneladas de discussão. Vida que segue! ;)

Edcronos

25-11-2015 12:17:02

sobre nomes de variaveis eu gosto de usar nomes curtos
a não ser para parâmetros
nomes longos embaralham minha visão,
" sem falar que mesmo com uma descrição se eu não souber exatamente oq faz para mim é a mesma coisa que nada"

coisa que sinto falta no vbe é a opção de recolher trechos de linhas de codigo
isso facilitaria tanto no desenvolvimento de macros complexas quanto em organizar e editar
e muito mais para documentar,
já que se poderia colocar uma descrição detalhada e deixar oculto para não atrapalhar a visualização do codigo em si