Vadim Lebedev a écrit :
Hello Vadim,
Just wanted to point out two things about Doxygen comments:
First: if I'm not mistaken, OpenWengo project coding style says that
Doxygen comments should be in .h files, so they should not annoy you
when reading source code.
Second: if you haven't tried it, I suggest you have a look at Doxygen
source code output. It's a nice way to explore existing code (at least
it was really useful for me to get started on the OpenWengo project,
and it still is when I am wandering into parts of the code I don't
know yet).
The nice thing about this output is that:
- Big Doxygen comment templates have been removed.
- All classes and methods are hyperlinked, making it really convenient
to browse from one method call to its doc and then to its implementation.
Now,
I'm perfectly aware of Doxygen capabilities and i do agree that Doxygen
compatibility is a GOOD thing
for coding style rules.
However most of the time coders spend in the editor window and not
looking to doxygen output and inside
the editor all this doxygen stuff is pretty annoying. As i said before
the positive effect of doxygen compatiblity
IMO outweighs the negiative effect.
Ok, I agree, but what I was trying to say is that it can be an
interesting experience to try to leave the editor for a while and browse
the code using Doxygen output.
I see your point, but I think this method has a major drawback: when
someone needs to implement some kind of transverse change, he may have
to adjust to a different coding style for each file he edit.
On this point however we've a disagreement.
I believe that what you see as amajor drawback is MAJOR ADVANTAGE instead.
This way a person have to try something differrent that he is doing usually
which gives him a chance to learn something new and become better coder.
The important thing that it comes
in small doses so the person does not feel himeself defintively
'forced'. Everebody is capable to adopt
some different 'accent' for a short moment.
Well... I guess we won't be able to find an agreement here. I will just
add that I found myself able to try something different by
working/contributing on different projects. As far as I'm concerned it's
enough for me, I prefer when things aren't too different inside one
project, but then I am a dangerous code perfectionist :-)
> BTW i'd like to stress, that i'm not talking in the air here, my 3
rules are outcome of some 30 years of coding and
project management experience and actually were applied with great
success in large projects.
Hehe, me neither :-) I can't claim 30 years of coding, but I have been
doing this job professionally for 13 years now (thanks to
apprenticeship...).
Aurélien
Aurélien
_______________________________________________
Wengophone-devel mailing list
[email protected]
http://dev.openwengo.com/mailman/listinfo/wengophone-devel
