Padrão de comentários em c

[Red Neck Guy]

Tem aquele tipo de comentário que enche o saco.

Código: Selecionar todos

int valor; // variavel para contar

valor += 1; //soma 1 ao valor
valor^= 0xFF; // Faz xOR com FF

...


Esse tipo de comentário é normal quando falam pro estagiário: "Tem que comentar o código".

Eu coloco comentários só naquelas partes que tem algum detalhe para ser lembrando, por exemplo, num treco poderia estar otimizando uma formula para calcular alguma coisa, seria interessante deixar no comentário daonde veio aquilo.
[/code]

[Fandango]

Gente, faço softwares há mais de 20 anos (sou da época do cartão perfurado ). Começei com FORTRAN, passei pelo Basic, fui no Assembly (desde o 6502, 8085, Z80, 8051, etc.), cheguei no C, mexi com Delphi e VB... e o que posso dizer é que no início, enquanto implementava, Deus e eu sabíamos o que eu estava fazendo... 2 dias depois, só Deus sabia, porque eu já nem lembrava prá que servia a variável y.

Comentar só traz vantagens (exceto comentários de estagiários do tipo "incrementa X"... sem preconceito!). O bom senso e a coerência é que devem prevalecer (na minha humilde opinião).

Hoje trabalho praticamente só com C, e tenho o hábito de incluir um cabeçalho em cada função, descrevendo para que serve, os seus parâmetros de entrada e de retorno. Além disso costumo incluir alguma observação importante ou nota de projeto (tipo: "A chamada deve ser efetuada com as interrupções desabilitadas", ou algo do tipo: "este procedimento deverá ser executado antes de chamar a função Z")
No interior da função comento apenas o que é relevante, mas usando comentários referentes à aplicação, explicitando o significado daquela linha.

Além de ter este hábito para meu próprio benefício, meus clientes (quando recebem o código-fonte) ficam muito satisfeitos, porque percebem a transparência da coisa, ou seja, notam que não escondo nada e nem omito informações importantes. Afinal, eles pagam pelo meu serviço e se, no dia de amanhã me der uma daquelas "caganeiras", eles saberão se virar e dar manutenção ou realizar adequações.

Conselho do velho Fandango... Comente sempre, mas nunca sobre a mulher ou a filha do chefe.

[fabim]

Um velho guru amigo meu me disse uma vez.
Quando fizer um software, para uma determinada aplicação.
Separe tudo em varias partes, cada arquivo para o bloco logico a ser utilizado.
Crie um header universal de prototipos, e faça comentarios neste header, para não poluir os *.c.
Só segui a primeira parte.

O segundo canguru, me disse uma vez.
Um bom programador em C, faz programas em C, em qualquer linguagem. Foda-se o proximo cara que for usar o codigo, você foi dispensado, e o intelecto foi seu. O cara que por ventura quiser usar o codigo, que faça outro do zero.!!!

E segui o conselho dele agora!!!

[Fandango]

Pô Fabim, que egoísmo é esse?
Tem um cara aqui em Floripa que trabalha desse jeito... prá mim é super interessante, porque o cara vive sendo dispensado de tudo o que é empresa... o resultado é que sempre me chamam para limpar a m**** dele (refazer o firmware)
Ainda não fiquei rico, mas de continuar assim minha aposentadoria está garantida!

[fabim]

não confunda imcompetência, com egoismo.
Trabalhei 10 anos e 5 meses numa empresa, e fui dispensado pra ganhar 3X mais... hehehe

Meus fw são super comentados, quando me pagam bem pra isso.

né proex ?

[Red Neck Guy]

O comentário mais legal de ser fazer é aquele que coloca em duvida a capacidade técnica de alguém que venha a dar manutenção no código no futuro:

Código: Selecionar todos


sem_wait(thread_lcd); // Se sabe o que é um semafáro, não preciso dizer mais nada....



[/code]

[andre_luis]

Há também aqueles comentários narcisistas, no qual um alguem pretende registrar que participou da programação :

Código: Selecionar todos

 // by FSilva

+++

[Djalma Toledo Rodrigues]

Bons comentários não podem melhorar uma má codificação mas, maus comentários
podem comprometer seriamente uma boa codificação.
(Jean-Paul Temblay - Richard B. Bunt)

Falow

DJ