Como comentar devidamente o código (C)?

[FELiYCORA]

Boas,

Tenho um projecto para terminar nas férias e tenho que comentar o código que irei apresentar. Nas aulas por vezes coloco umas linhas de comentários, no entanto gostaria de saber se existe algum tipo de normalização, formalismo e regras nos comentários de código, mais propriamente em C.

Obrigado desde já.

 

[HecKel]

Comentar tudo o que não é intuitivo. O trivial é escusado de ser comentado, só é meter o ficheiro com lixo.

O uso do /* texto */ é muito giro, mas quem utiliza o mooshak por vezes tem problemas nos comentários neste formato, por vias das dúvidas comento sempre só com o //

abraços, HecKel

 

[souto]

pessoalmente comento sempre antes das funçoes, ao estilo java:

/**
* info de funçao (nome, parametros)
* requires qq coisa ,por ex: !full()
* ensures: qq coisa (evento, valor, bleble)
*/

entre linhas comento com /* */, até porque // não é norma em C.

cumprimentos.

 

[Rui_Carlos]

vê este site: http://www.stack.nl/~dimitri/doxygen/

 

[MaxDamage]

pessoalmente comento sempre antes das funçoes, ao estilo java:

/**
* info de funçao (nome, parametros)
* requires qq coisa ,por ex: !full()
* ensures: qq coisa (evento, valor, bleble)
*/

entre linhas comento com /* */, até porque // não é norma em C.

cumprimentos.

Exacto, sempre com /* ... */, comentando o código não-obvio

 

[MeY-ZiNG]

O uso do /* texto */ é muito giro, mas quem utiliza o mooshak por vezes tem problemas nos comentários neste formato, por vias das dúvidas comento sempre só com o //

Não tenho a certeza, mas acho que as "//" não fazem parte das normas do "ANSI C", pois não? Se não fazem então podem dar problemas com certos compiladores... (e muitas vezes os enunciados de projectos da faculdade obrigam a compilar com 'ansi')

 

[alph]

Doxygen FTW!

 

[xanatos]

Não tenho a certeza, mas acho que as "//" não fazem parte das normas do "ANSI C", pois não? Se não fazem então podem dar problemas com certos compiladores... (e muitas vezes os enunciados de projectos da faculdade obrigam a compilar com 'ansi')

O "//" não faz parte das normas "ANSI C".
Ao usares algumas flags de compilação ele estrilha logo com isso, o correcto é usar /* ... */ numa só linha.
Embora eu faça como o souto e antes de cada função faço uma descrição tipo Java, depois comento alguma linha que faça alguma coisa mais complicada.

 

[Rui_Carlos]

O "//" não faz parte das normas "ANSI C".
Ao usares algumas flags de compilação ele estrilha logo com isso, o correcto é usar /* ... */ numa só linha.

não faz parte do "ANSI C", mas faz parte do "C99", que é o último standard do C.

 

[_jr]

Devias estar é mais preocupado com a qualidade do comentário do que com a forma de o comentar :-) lol

 

[xanatos]

não faz parte do "ANSI C", mas faz parte do "C99", que é o último standard do C.

Obrigado, desconhecia isso.

 

[MeY-ZiNG]

não faz parte do "ANSI C", mas faz parte do "C99", que é o último standard do C.

só falei por causa dos projectos da faculdade, em que muitas vezes só aceitam ANSI... porque os comentários com "//" já são usados há bastante tempo!

 

[FELiYCORA]

Devias estar é mais preocupado com a qualidade do comentário do que com a forma de o comentar :-) lol

foram as minhas primeiras vezes a programar (em C e "a sério"), não achas que deva saber se existem algumas regras e formalismos para comentar? a qualidade já depende de mim, mas de que vale a qualidade se não é usada onde é devido?

acho que se nunca tivesses programado farias a mesma pergunta

 

[_jr]

Calma, tens razão :-) Mas não consegui evitar fazer o /* comentário */ :-)