Very low number of comments

Rodrigo Souto rodrigo at colivre.coop.br
Wed May 7 11:09:56 BRT 2014


Hey Bráulio,

I think this is consequence of a cultural misconception around a
sub-group of the ruby community that believes ruby is too human-readable
too need comments and if for some reason a code you wrote need comments,
then you are doing it wrong. This culture was really strong on Noosfero
too. By experience, I believe this is not true. I don't think comments
only serves to justify bad codes, although this is one of the main
reasons why people created this kind of grudge towards them. Comments
are really useful specially with good code that is, by nature, hard to
read. I too think we should comment more. Even start to properly use
rdoc in-code documentation.


Bráulio Bhavamitra escreveu isso ai:
> Hello all,
> 
> Taking a look at ohloh I saw what something I've already realized:
> noosfero has very few comments.
> https://www.ohloh.net/p/noosfero/factoids#FactoidCommentsVeryLow
> 
> I agree with that. Besides, many comments are for obvious things, that
> is, they shouldn't exists, but many other non obvious parts should
> have comments.
> 
> Comments, as automated tests, helps with maintainability of code. In
> code without automated tests like the linux kernel and other C
> projects, they play a very important role.
> 
> best regards,
> bráulio
> 
> -- 
> "Lute pela sua ideologia. Seja um com sua ideologia. Viva pela sua
> ideologia. Morra por sua ideologia" P.R. Sarkar
> 
> EITA - Educação, Informação e Tecnologias para Autogestão
> http://cirandas.net/brauliobo
> http://eita.org.br
> 
> "Paramapurusha é meu pai e Parama Prakriti é minha mãe. O universo é
> meu lar e todos nós somos cidadãos deste cosmo. Este universo é a
> imaginação da Mente Macrocósmica, e todas as entidades estão sendo
> criadas, preservadas e destruídas nas fases de extroversão e
> introversão do fluxo imaginativo cósmico. No âmbito pessoal, quando
> uma pessoa imagina algo em sua mente, naquele momento, essa pessoa é a
> única proprietária daquilo que ela imagina, e ninguém mais. Quando um
> ser humano criado mentalmente caminha por um milharal também
> imaginado, a pessoa imaginada não é a propriedade desse milharal, pois
> ele pertence ao indivíduo que o está imaginando. Este universo foi
> criado na imaginação de Brahma, a Entidade Suprema, por isso a
> propriedade deste universo é de Brahma, e não dos microcosmos que
> também foram criados pela imaginação de Brahma. Nenhuma propriedade
> deste mundo, mutável ou imutável, pertence a um indivíduo em
> particular; tudo é o patrimônio comum de todos."
> Restante do texto em
> http://cirandas.net/brauliobo/blog/a-problematica-de-hoje-em-dia
> _______________________________________________
> Noosfero-dev mailing list
> Noosfero-dev at listas.softwarelivre.org
> http://listas.softwarelivre.org/cgi-bin/mailman/listinfo/noosfero-dev

-- 
Rodrigo Souto <rodrigo at colivre.coop.br> :: 55 71 8131-7714
Colivre - Cooperativa de Tecnologias Livres
http://www.colivre.coop.br/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 490 bytes
Desc: Digital signature
URL: <http://listas.softwarelivre.org/pipermail/noosfero-dev/attachments/20140507/b05239b5/attachment.pgp>


More information about the Noosfero-dev mailing list