| T O P I C R E V I E W |
| Michael Kelley |
Posted - May 16 2007 : 7:26:21 PM
Document Method is a very useful feature. I'd like to request a feature that I think would improve this feature.
I'd like to have the functionality of ghostdoc (http://ghostdoc.12.forumer.com/viewforum.php?f=7&sid=3a8055b30bb8301378308542f247dcbd)
for C++ methods. Ghostdoc auto fills in comments based on the method name and its parameters. What about allowing users to write a .dll that is called when the "Document Method" is called? Functions in the user supplied .dll would receive a description of the method; you could probably use the classes in the Visual C++ code model as the instance types that are passed into the user .dll function (http://msdn2.microsoft.com/en-us/library/ms228770 VS.80 .aspx).
The user supplied .dll would just return a string to Visual Assist that contains the modified method documentation, and Visual Assist would insert that string as the method documentation. You could even pass in the previous comment block so that the user .dll could parse that original block and use information from that original block.
|
| 3 L A T E S T R E P L I E S (Newest First) |
| feline |
Posted - Jun 05 2007 : 4:55:06 PM
Simply edit the autotext entry "Refactor Document Method" to produce comments in the format and style that you want:
http://www.wholetomato.com/products/features/documentMethod.asp |
| James |
Posted - Jun 05 2007 : 4:06:22 PM
Like Ghostdoc in languages that support documentation comments the I'd like to see the Document Method menu option produce documentation like this:
/// <summary>
/// Handles the Load event of the Page control.
/// </summary>
/// <param name="sender">The source of the event.</param>
/// <param name="e">The <see cref="System.EventArgs"/> instance containing the event data.</param>
instead of this:
//////////////////////////////////////////////////////////////////////////
// Method: Page_Load
// FullName: com.Collectors_Society.AbandonSession.Page_Load
// Access: private
// Returns: void
// Parameter: object sender
// Parameter: System.EventArgs e
//////////////////////////////////////////////////////////////////////////
|
| sean |
Posted - May 16 2007 : 8:55:24 PM
You can make VA prompt you for text during document method (single line entry) by editing the Refactor Document Method autotext item (VAssistX | VA Options | Advanced | Suggestions | Edit Autotext | C++ | Refactor Document Method).
Add up to 8 words delimited by $ (for example: $summary$, $description$). When Document Method is invoked, VA will prompt for substitutions. |
