search

InfoJrUFBA / Guia-de-Estilo-InfoJr-UFBA

Guia de estilização de código da InfoJr UFBA
4 stars 1 forks source link

Exemplo item 1.6 #6

Closed aobruno closed 8 years ago

aobruno commented 8 years ago

Faltou um exemplo prático de como utilizar um comentário

ramos13 commented 8 years ago

O tópico 1.6 passou a ser 1.5, e os comentários solicitados foram incluídos.

mateuscgc commented 8 years ago

Eu tava junto com Davi quando o texto dessa seção foi feito, pelo que eu me lembro a ideia seria que o comentário fosse explicado no guia da própria linguagem, por isso não teria exemplo nessa seção. No caso teria que mudar um ou o outro

Aproveitando sugiro essa mudança no texto da seção

1.5 Comentários

Conforme necessário, utilize os comentários para explicar o código, conforme necessário, um trecho de código, sempre que preciso. indicando o que ele cobre, qual a finalidade, para que serve etc. Isso O uso de comentários facilita a compreensão do mesmo por outras pessoas que tiverem acesso ao seu códigocódigo por outros desenvolvedores. Para fazer um comentário, para cada linguagem com a qual estiver desenvolvendo, use utilize de preferência a marcação indicada no guia de estilo referente a essa linguagemda linguagem em questão.

To reabrindo a issue para que @ramos13 dê uma olhada