Shorter syntax for grouping class members
Daniel Ferber <[email protected]>
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Message-ID | <[email protected]> |
Hi,
I would like to propose a shorter, easier and more readable syntax for
grouping members in a class. I searched the mail archive but didnt find
messages about this.
With doxygen, if I want to create a group of class members, nowadays I have to
write:
/**
* @name ...
* About the group
*/
//@{
...
//@}
My suggestion is to create a new command (eg @members) that automatically
starts a new group which goes until the next @members or until the class is
closed.
/**
* @members About the group
*/
....
/**
* @members About the group
*/
....
IMHO, my suggestion is simplier and more readable.
In large classes, with many groups, the lines with //@} and //@{ comments
make them difficult to read. IDEs do not understand these comments and do not
provide folding or hiding. The grouping results in an overhead of 4
additional lines. The //@} and //@{ are difficult to see and easy to forget.
On well organized projects, class attributes and methods are frequently
grouped. I like to group them at least like: attributes, references,
constructor/destructor and several groups of methods.
As this kind of grouping is very frequent, I believe that it could have a
special syntax for it.
I am only concerned with classes, but I think a more gerenal model could be
implemented to make grouping of other entities easier and more readable.
Thanks,
DAniel FF
-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems? Stop! Download the new AJAX search engine that makes
searching your log files as easy as surfing the web. DOWNLOAD SPLUNK!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=103432&bid=230486&dat=121642