| Author |
 Topic  |
|
|
chowette
New Member
6 Posts |
 Posted - Jul 13 2006 : 04:00:02 AM
|
It would be great if the move implementation can also duplicate the comment to the source file.
Maybe it can also use the Refactor Document Method auto text template?
|
|
|
jpizzi
Tomato Guru
USA
642 Posts |
Posted - Jul 14 2006 : 12:23:54 AM
|
| The idea so far is to provide small, individual choices that could be chained together so that you can get what you want accomplished, but we don't have to provide too many options about what to chain. |
Joe Pizzi |
 |
|
|
feline
Whole Tomato Software
United Kingdom
19021 Posts |
Posted - Jul 15 2006 : 11:37:24 AM
|
| there is a practical problem with copying the comment from the header, the two comment blocks will instantly start to go out of sync. before you ask, getting VA to keep the two comment blocks in sync is very unlikely to happen, there are just far to many ways this could go horribly wrong. |
zen is the art of being at one with the two'ness |
|
|
|
chowette
New Member
6 Posts |
Posted - Jul 17 2006 : 02:59:02 AM
|
In general, I put a brief comment in the header, using
/// Brief comment.
and in the implementation file, using
/**
*Brief comment.
* More Detail here, like parameters and return ( what Refactor Document Method do)
*/
then, using JAVADOC_AUTOBRIEF set to YES in doxygen, I get a nice class description.
I think it's up to me to keep comments in sync.
What I need is a quick way to implement a method. This also imply commenting for doxygen.
Today I need a lot of document switchs to just cut and past some comments... This is just a big waste of time...
Thank anyway for VA ! |
|
|
|
feline
Whole Tomato Software
United Kingdom
19021 Posts |
Posted - Jul 17 2006 : 6:33:13 PM
|
you may want to add an autotext rule with the shortcut ///
i have 5 of them myself, so when i type triple slash i get to choose the one i want. i have a selection of doxygen format comment lines in the list, ideal for quickly entering short formatted comments. |
zen is the art of being at one with the two'ness |
|
|
|
chowette
New Member
6 Posts |
Posted - Jul 18 2006 : 03:21:24 AM
|
Can you share those shortcut ?
I am just curious about them... |
|
|
|
feline
Whole Tomato Software
United Kingdom
19021 Posts |
Posted - Jul 20 2006 : 5:27:55 PM
|
i dont seem to have them on this machine, so this is from memory. they are all keyed to the same shortcut "///"
///< $end$
/// \\brief $end$
/// \\param $end$
/// \\return $end$
and then i threw in a "dated comment block" one, which is useful now and then
//********************************************************
// %DAY% %MONTH% %YEAR%
// $end$
//********************************************************
once you see the idea the rest should be fairly obvious. it is just a matter of having some useful formatted blocks easily on hand. |
zen is the art of being at one with the two'ness |
|
|
|
chowette
New Member
6 Posts |
Posted - Jul 21 2006 : 03:06:24 AM
|
Thanks, I got the idea.
I already have some keyed to "/**"
/**
* $end$
*/
/**
* \\brief $end$
*/
But I still have to cut-and-past the brief comment from the .h file.
As a side question, where can I get the list of all reconised variables like %DAY%, $DAY_02$, $FILE_BASE$ or $end$ ? |
|
|
|
support
Whole Tomato Software
5566 Posts |
|
|
feline
Whole Tomato Software
United Kingdom
19021 Posts |
Posted - Jul 22 2006 : 11:37:13 AM
|
| if your brief comment is on one line only then depending on your IDE and its settings CTRL-C with nothing highlighted will copy the entire current line, allowing you to do CTRL-C -> ALT-O -> CTRL-V, or some variant of this. |
zen is the art of being at one with the two'ness |
|
|
| |
Topic |
|
Move implementation AND comment
