If what we write first is "the simplist
thing that might work", then I'd suggest comments should explain
code that is not apparently the "the simplist thing that might
work". or "comments should explain why the simplistic thing that
might have worked, didn't"
And on regular expressions - the minimum comment should include at least one example of the "line" being matched against. It makes a huge improvement to the grokkability of a regex if you can see an example of what is being searched. Bruce On 15/04/2013 8:50 a.m., Cédric Beust ♔ wrote:
-- You received this message because you are subscribed to the Google Groups "Java Posse" group. To unsubscribe from this group and stop receiving emails from it, send an email to javaposse+unsubscr...@googlegroups.com. To post to this group, send email to javaposse@googlegroups.com. Visit this group at http://groups.google.com/group/javaposse?hl=en. For more options, visit https://groups.google.com/groups/opt_out. |
- [The Java Posse] #418: Comments should be treated as a... Reinier Zwitserloot
- Re: [The Java Posse] #418: Comments should be tre... Cédric Beust ♔
- Re: [The Java Posse] #418: Comments should be... Kirk Pepperdine
- Re: [The Java Posse] #418: Comments shoul... Cédric Beust ♔
- Re: [The Java Posse] #418: Comments s... Bruce Chapman
- Re: [The Java Posse] #418: Comme... Cédric Beust ♔
- Re: [The Java Posse] #418: Comme... Kevin Wright
- Re: [The Java Posse] #418: Comme... Kirk Pepperdine
- Re: [The Java Posse] #418: Comme... Vince O'Sullivan
- Re: [The Java Posse] #418: C... Roland Tepp
- Re: [The Java Posse] #41... Fabrizio Giudici
- Re: [The Java Posse] #41... Roland Tepp
- Re: [The Java Posse] #41... Fabrizio Giudici
- Re: [The Java Posse] #418: C... Reinier Zwitserloot
- Re: [The Java Posse] #41... Roland Tepp