Whole Tomato Software Forums
Whole Tomato Software Forums
Main Site | Profile | Register | Active Topics | Members | Search | FAQ
User name:
Password:
Save Password
Forgot your password?

 All Forums
 Visual Assist
 Feature Requests
 xml documentation not supported
 New Topic  Reply to Topic
 Printer Friendly
Author Previous Topic Topic Next Topic  

enigma
Senior Member

49 Posts

Posted - Feb 27 2007 :  11:14:40 PM  Show Profile  Reply with Quote
The refactoring tool in VA X does not support XML documentation. I would be nice if it is supported. The reason I raise this issue is that I am doing c# development and the documentation is written in XML format

http://itscommonsensestupid.blogspot.com/

Edited by - enigma on Feb 27 2007 11:16:45 PM

feline
Whole Tomato Software

United Kingdom
19021 Posts

Posted - Feb 28 2007 :  08:58:01 AM  Show Profile  Reply with Quote
Document Method uses the Autotext entry "Refactor Document Method" for the current language, so all you need to do is edit this to produce the format you want. using VS2005 and VA 1548 I have just changed the C# autotext rule to be:

/// <summary>
/// $end$
/// </summary>
/// <param name="$MethodArgName$"></param>

and this works wonderfully for me.

zen is the art of being at one with the two'ness
Go to Top of Page

enigma
Senior Member

49 Posts

Posted - Feb 28 2007 :  8:06:35 PM  Show Profile  Reply with Quote
quote:
Originally posted by feline

Document Method uses the Autotext entry "Refactor Document Method" for the current language, so all you need to do is edit this to produce the format you want. using VS2005 and VA 1548 I have just changed the C# autotext rule to be:

/// <summary>
/// $end$
/// </summary>
/// <param name="$MethodArgName$"></param>

and this works wonderfully for me.



Great post. But I believe that it would be better if you set this format as the default for c# documentation so that users don't have to do manual configuration themselves

http://itscommonsensestupid.blogspot.com/
Go to Top of Page

feline
Whole Tomato Software

United Kingdom
19021 Posts

Posted - Mar 01 2007 :  1:33:44 PM  Show Profile  Reply with Quote
I noticed that myself when I went in and edited it. I have put in a case to change the default format:

case=5314

zen is the art of being at one with the two'ness
Go to Top of Page

support
Whole Tomato Software

5566 Posts

Posted - Jul 07 2007 :  12:28:55 AM  Show Profile  Reply with Quote
case=5314 is fixed in Build 1559
Go to Top of Page

feline
Whole Tomato Software

United Kingdom
19021 Posts

Posted - Jul 07 2007 :  08:26:03 AM  Show Profile  Reply with Quote
Note you will need to delete your existing C# Refactor Document Method autotext entry before VA will insert the new default. The new default will be inserted next time you trigger Document Method.

zen is the art of being at one with the two'ness
Go to Top of Page

dango
Junior Member

20 Posts

Posted - Jul 07 2007 :  09:40:59 AM  Show Profile  Reply with Quote
Try Ghost Doc add-in from Roland Wigeit: http://www.roland-weigelt.de/ghostdoc/

It does a great job of creating default documentation by parsing the method and argument names. It also uses base type or interface documentation to create documentation. (Think of a class that inherits from IEnumerable).

I think it won some add-in contest in its 1.0 version. The latest version supports orcas beta 1 it also supports both vb and c# (I continue to use Vax for c++).

Go to Top of Page
  Previous Topic Topic Next Topic  
 New Topic  Reply to Topic
 Printer Friendly
Jump To:
© 2023 Whole Tomato Software, LLC Go To Top Of Page
Snitz Forums 2000