On Tue, Oct 30, 2012 at 3:02 PM, Mahesha HS <[email protected]> wrote:
> I understand that current coding guidelines are strictly against > duplicating routine/class name in documentation comment though old > code is written that way, but, I could still see this kind of > duplication in few recent check-ins, after I got this review comment > for one of my recent patches. So, I am curious to send this mail. > > > -- > mahesha > _______________________________________________ > cfe-commits mailing list > [email protected] > http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits > It is generally discouraged because duplication causes documentation to go out of date whenever the function/class name changes: it's a drag to remember to update the comment and many times people don't. Instead, it's simply easier to let Doxygen correctly assess which class/function the comment targets. It just works! -- Matthieu
_______________________________________________ cfe-commits mailing list [email protected] http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
