March 28, 2024

#005 – Comenta, documenta e senta que é de menta

Com o espírito de reviver clássicos da música brasileira trazemos para vocês mais um The Walking Dev!

Conseguimos juntar toda a equipe do site para discutir comentários de código e documentações em projetos. Apesar de ser um tema já bem discutido aqui no site, atualizamos nossa visão (por vezes anárquica) desse tema sempre polêmico. Escute, comenta, divirta-se e lembre-se: se for sexta-feira, rode a SE14 na MARA (por sua conta e risco, claro).

Críticas? Dúvidas? Sugestões? Você já foi passear com o cachorro e falou que estava testando um ALV? Então comente aí embaixo!
Muito obrigado por ter escutado e até a próxima! \o/

Quer baixar o “Dia de Maldade ABAP” separadamente para mandar para os coleguinhas? Clique aqui (com o direto > Salvar como)

Links e recomendações do episódio:

Posts do ABAPZombie sobre o tema:

Documentações e o tempo perdido que não volta mais

A arte milenar de comentar códigos ABAP

ASCIIDOC

Porque comentar código não é legal

Comentários bizarros do Standard

Mauricio Cruz

Pasteleiro há 15+ anos e criou o ABAPZombie junto com o Mauro em 2010. Gosta de filosofar sobre fundamentos básicos da programação e assuntos polêmicos. Não trabalha mais com SAP, mas ainda escreve sobre programação e faz vídeos de vez em quando.

View all posts by Mauricio Cruz →

20 thoughts on “#005 – Comenta, documenta e senta que é de menta

  1. Muito bom o Podcast… poderia ser diário!
    Quanto ao comentários, sou igual ao Leo…. mas como eu tenho que seguir os padrões da empresa, deixo tudo comentado! rs

  2. Galera,

    Bacana o posto eim. Algumas coisas também concordo com o que vocês falaram, mas numa próxima tinha que trazer um para defender os comentários. KKKK..

    Abraço!!!

    1. Olá Diego, muito obrigado pelo elogio.

      Até procuramos alguém pra defender os comentários de código, mas ninguém quis participar pois estavam todos muito ocupados em projetos de enxugamento de gelo e desentortagem de banana.

      Abraços.

      1. Leo,

        Não muda nada mesmo. Não que eu seja um defensor de comentário, mas como estava falando com o pessoal aqui, as vezes o cara comenta simplesmente porque sem comentário parece que falta algo até por isso sai os “Selecionar tabela Mara” logo antes da seleção da MARA.

        1. Ah, é que nem a gente comentou mesmo, a galera às vezes faz por tradição. Se vc para e pensa antes de fazer, dificilmente vc vai encontrar uma utilidade.

  3. Prá deixar meu curtir do face aqui….

    comentário esse Leo é uma farsa, posso provar com códigos que ele mexeu recentemente e não removeu os comentários !!!… kkk

    Quero ver vcs ganharem do nome da Tabela de Transações de Analistas, que um gerente do cliente (que era pago para revisar nossas documentações) deu um chilique esbravejando “- Quem tem coragem de criar uma tabela com este nome….ZTRAxxx_ANxxx !!!”… bem acredito que não preciso completar os “xxx”…

    []s

    1. Ooooooooooorraaaaaaaaaaaa

      Quer dizer que o movimento anárquico é uma farsa? ME ENGARAM

      1. Caro Bonini,

        Obrigado pelo comentário (estou me controlando para não deletá-lo).

        Ultimamente neste projeto não estou com muito tempo (tampouco paciência) para limpar comentários inúteis, então algumas coisas estão realmente escapando. Prometo retornar ao comportamento xiita em breve.

        Grato,
        Leo

  4. Fala Zumbis,

    Sou ouvinte assíduo e admirador do trabalho do Maurício (Leitor Número 1 do Livro™) e mesmo não trabalhando com ABAP me divirto (e aprendo, por que não?) ouvindo os podcasts.

    Prometi pra mim mesmo que vou comentar todos os casts, já que valem a pena!

    Com relação a documentação, nos meus 10 anos trabalhando com TI, vi que não difere muito não a questão de documentar o que é feito (os famosos procedimentos) e segue uma história que representa bem a preguiça de documentar:

    Entrei em uma empresa e os erros de alguns sistemas éramos orientados a falar com o Paulo Pereira*.

    “Passa pro PP”
    “Ah, isso é com o PP”
    “Liga pro PP que ele resolve!”

    E nos e-mails de resolução o PP somente escrevia “Atendido por Paulo Pereira”.

    Até o dia que o PP saiu da empresa e todos que trabalhavam com ele ficaram na mão, a solução foi ligar para outras pessoas que já sabiam as soluções ou muita, muita buscas nas comunidades e no google (com agravante que não tínhamos nem código, nem programa, nada para debugar e encontrar uma solução!).

    Um abraço e até o próximo cast!

    *Nome fictício

    Ricardo

    1. Gostaria de dizer que o Ricardo de fato tem o título de Primeiro Leitor Pós-Publicação™ e que se você tem algum problema com isso, fale com o PP.

      Atendido por Mauricio Cruz

      (valeu mano! 😀 )

  5. Acabei de passar pelo seguinte comentário:

    * Do the calculations by hand. This is going to be slow. This is going to be a pain.
    * What is a man to do?

    cl_abap_zip=>crc32

  6. Poxa galera, muito bacana!!
    Sou iniciante no mundo ABAP e fico comparando as vantagens da orientação a objetos com as desvantagens da estrutural. A maioria das pessoas que conversei do mundo ABAP não usam orientação a objetos, acho que existe uma certa preguiça e quebra de paradigma em usar orientação a objeto. As pessoas não compreendem que o trabalho que é exigido no momento e a “perda de tempo” em escrever mais linhas com a orientação a objetos nos promovem ganhos com manutenção.
    Continuem postando e acrescentando aos nossos conhecimentos, aprendi muito com vocês.

    Valeu galera, abraco

Leave a Reply to Mauro Laranjeira Cancel reply

Your email address will not be published. Required fields are marked *