1. Este site usa cookies. Ao continuar a usar este site está a concordar com o nosso uso de cookies. Saber Mais.

Como comentar devidamente o código (C)?

Discussão em 'Programação' iniciada por FELiYCORA, 19 de Dezembro de 2006. (Respostas: 13; Visualizações: 4806)

  1. FELiYCORA

    FELiYCORA 1st Folding then Sex

    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á.:)
     
  2. HecKel

    HecKel The WORM

    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
     
  3. souto

    souto To fold or to FOLD?

    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.
     
  4. MaxDamage

    MaxDamage Power Member

    Exacto, sempre com /* ... */, comentando o código não-obvio :)
     
  5. MeY-ZiNG

    MeY-ZiNG Power Member

    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')
     
  6. alph

    alph Power Member

  7. xanatos

    xanatos To fold or to FOLD?

    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.
     
  8. Rui_Carlos

    Rui_Carlos 1st Folding then Sex

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

    _jr Power Member

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

    xanatos To fold or to FOLD?

    Obrigado, desconhecia isso.
     
  11. MeY-ZiNG

    MeY-ZiNG Power Member

    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!
     
  12. FELiYCORA

    FELiYCORA 1st Folding then Sex

    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
     
  13. _jr

    _jr Power Member

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

Partilhar esta Página