Documentar se aprende na marra
 
De 2006 ao início de 2008, trabalhei em uma empresa em que alem de comentar o código, tinhamos que escrever wikipages de cada coisa que fazíamos. Tudo também era submetido a um controle de versão, cada commit tinha que ter um porquê.
 
No início foi muito tedioso, via de regra caíamos na tentação de comentar e documentar cada "if' que existia, mas com o tempo fomos aprendendo o que comentar, o que documentar e como fazer isso.
 
No ínício, as rotinas no R eram .R cheias de comentários, a gente simplesmente baixava do svn e rodava, os resultados e datasets eram comitados em outra pasta, muita burocracia.
 
Durante uma semana em que estava mudando de emprego, iniciei a aventura de escrever pacote, foi um parto, .mas descobri alguns erros preocupantes em algumas funções, os quais informei para a empresa que eu estava anteriormente. Estes erros só foram descobertos devido ao jeito como a gente documentava as coisas.
 
Continuo fazendo isso? não, essa foi minha única experiência com pacotes.

lmassis <at> yahoo <dot> com <dot> br
assis.leonard <at> gmail <dot> com


2011/8/11 Leandro Marino <leandromarino@leandromarino.com.br>
Gosto da possibilidade de pacotes, apesar de ainda não ter feito nenhum. nos meus primeiros testes todos estao totalmente NÃO documentados...

Enfim... Como são funções quase auto-explicativas (só eu e o Prof. Ruben entendemos) =P

O problema é que ainda temos que generalizar muitas delas...

Atenciosamente,
Leandro Marino
http://www.leandromarino.com.br (Fotógrafo)
http://est.leandromarino.com.br/Blog (Estatístico)
Cel.: + 55 21 9845-7707
Cel.: + 55 21 8777-7907



Em 11 de agosto de 2011 21:05, Jose Claudio Faria <joseclaudio.faria@gmail.com> escreveu:

Eu venho cedendo a essa tentação a tantos anos... ;)
(Mas minhas funções de uso pessoal são bem documentadas)

Abs,
--
///\\\///\\\///\\\///\\\///\\\///\\\///\\\///\\\
Jose Claudio Faria
Estatistica - Prof. Pleno
UESC/DCET/Brasil
joseclaudio.faria at gmail.com
///\\\///\\\///\\\///\\\///\\\///\\\///\\\///\\\

Em 11 de agosto de 2011 20:17, Benilton Carvalho
<beniltoncarvalho@gmail.com> escreveu:
> Exatamente, Leonard, esse e' o modo que eu considero "correto" para
> gerenciar coisas assim.
>
> Mas ha' vezes nas quais cedemos `a tentacao... :-)
> _______________________________________________
> R-br mailing list
> R-br@listas.c3sl.ufpr.br
> https://listas.inf.ufpr.br/cgi-bin/mailman/listinfo/r-br
> Leia o guia de postagem (http://www.leg.ufpr.br/r-br-guia) e forneça código mínimo reproduzível.
>
_______________________________________________
R-br mailing list
R-br@listas.c3sl.ufpr.br
https://listas.inf.ufpr.br/cgi-bin/mailman/listinfo/r-br
Leia o guia de postagem (http://www.leg.ufpr.br/r-br-guia) e forneça código mínimo reproduzível.


_______________________________________________
R-br mailing list
R-br@listas.c3sl.ufpr.br
https://listas.inf.ufpr.br/cgi-bin/mailman/listinfo/r-br
Leia o guia de postagem (http://www.leg.ufpr.br/r-br-guia) e forneça código mínimo reproduzível.