Documentação, comentários

Assuntos Gerais Agile
#1

Galera não sei se off ou se é especifico deste tópico para este tipo de forum, mas como sou novo na área e logo de quebra já estou pegando strtus (havia feito curso de java, jsp e outros) vocês tem que convir que é dificil entrar na área sem experiência e já pegar logo uma aplicação J2EE, estou me esforçando mas anda meio complicado, vou tentar explicar a minha situação para ver se alguém com mais conhecimento possa me orientar um pouco.
1º estou numa empresa que pagou a uma empresa para gerar parte do modelo do sistema e eu terminar o resto, só que a regra de negócio já é complicada logistica.
2º na empresa tem-se: o Analista de NEgocios e eu (oreia, programador, escovador de bits o que quiserem), como sabem analista de negocios é só regras de negocios nada de implementação e código o que dificulta muito pra mim entender alguns códigos.
3º Sendo que cada aplicação aqui, são em torno de 8 arquivos passando do jsp, ejb, servlets, vo, bd, dao, xml, considero os códigos são pouco comentados, são comentários do tipo “Inicia a thread” em um arquivo que tem mais de 700 linhas e outros como:

  • Description of the Method

*@param loteDocumento Description of the Parameter
*@return Description of the Return Value
*@exception DaoException Description of the Exception
*/
estou exagerando em dizer que é pouco comentado?

o que eu queria era comentários de pessoas experientes, analistas e programadores a respeito disso, como são os comentários feitos, o que e como o analista de sistemas deve passar para o programador desenvolver, pois hoje aqui sei que tenho que seguir a arquitetura adotada mas agora vai eu entender o que já foi adotado.
Grato pela atenção de todos e desculpem pelo longo texto ou topic fora do forum destinado, mas o que mais me pareceu seria este.

#2

… eu nunca fui de ficar comentando código q é meu mesmo, mas onde trabalho tb uso algum comentário, mas só qnd é algo mais chato de entender ou se não da pra ver de cara de onde veio tal coisa…, sobre oq o analista passa pra mim, não tenho do q reclamar, me da um use case completo, … se bem q o sistema q tb peguei andando é totalmente fora de padrões, o processamento é todo feito no jsp, arrgghhh… mas ao finalizar esse, vai dar uma lavagem cerebral aqui se depender de mim heheahea :lol:

#3

Pois é galera, o lance é este, não sei estou exigindo demais para a empresa que elaborou este primeiro modo passe o mais comentado, já que aqui aonde o sistema está instalado e eu estou dando manutenção não há comentários maior, prefireria também começar algo do zero a entender a logica de outras pessoas. E como comentei aqui não tenho analista de sistemas sequer para comentar pra mim o que foi feito ali, é na base da dedução “eu acho queeeeeeeeeeeeee é aqui” ehhehe… mas a opinião de vocês ajudou. Só não estou sabendo se, resumindo, estou sendo muito lerdo e não entendendo as coisas ou se realmente a coisa deveria esta mais completa. Sobre comentar, quando você faz, desenvolve creio que assim que você for fazer uma manutenção você vai entender o que foi feito naquele dia, agora quando uma outra pessoa for dar esta manutenção cairá justamente na minha situação. Eu sitei isso tudo por ser novato e querer um help dos especialistas, afim de saber se o que estou exigindo é demais ou é algo que já deveria ser passado por eles.
Valeu pela atençaõ

#5