[Clam-devel] [PATCH] segmentation in chord extractor as a seperate class

[Roman Goj]

On 7/25/07, David García Garzón <dgarcia at iua.upf.edu> wrote:
(...)
> No. Inner comments are not parsed by doxygen. You should think that doxygen
> comments are the ones that appear here:
> http://clam.iua.upf.edu/doc/CLAM-doxygen/
>
> Besides that, in CLAM, we consider that commenting inner code a bad smell of
> having obscure code. So we have the rule that instead commenting inner code,
> we should make it clearer, by using proper variable names and methods. One of
> the smarter rules (that you can find in Martin Fowler's Refactoring book) are
> when you comment some code telling that 'it does someting', wrap it into a
> method called DoSomething and get ride of the comment.
>
> While commenting inner code is considered a bad smell, commenting method with
> doxygen is a very good thing as they allow a developer to use this method as
> a blackbox.
(...)

Great, thanks for the explanation, I'll try to keep it in mind while coding! :-)
I guess the reason why I first asked about commenting code some time
ago (and I mostly meant commenting inner code) has more to do with
getting around the code and not understanding it - I'm using vim's
syntax highlight right now and what I miss while browsing the code is
highlights on some variable names etc. So code where there are a lot
of things happening (even if the names are nice and informative) just
doesn't look that nice ... and comments introduce some more colour,
which gives the code "visual structure" and makes it easy to move
around in...

Obviously it's more a problem with how I use syntax highlighting
and/or my konsole coulour settings, so I'll be trying to fix that,
rather then introduce more useless comments ;-)

thanks again,
roman