Home Dashboard Directory Help
Search

VB.NET Projects require "Generate XML documentation file" to be checked to allow developers to use the VS Feature to auto generate the XML code comment tags. by eschneider8888


Status: 

Closed
 as Postponed Help for as Postponed


2
0
Sign in
to vote
Type: Bug
ID: 477562
Opened: 7/27/2009 9:17:47 AM
Access Restriction: Public
1
Workaround(s)
view
2
User(s) can reproduce this bug

Description

VB.NET Projects require the Project settings: "Generate XML documentation file" to be checked to allow developers to use the VS Feature to auto generate the XML Doc tags.

C# does not require the project settings to create XML Comments.

http://stackoverflow.com/questions/1088837/is-it-possible-for-visual-studio-2008-automatically-create-xml-comments-tags-with

Not generating XML doc file should not prevent a developer from creating the XML Comment tags.
Details
Sign in to post a comment.
Posted by Sindre Røbekk Hagerup on 5/8/2012 at 12:58 AM
Any news on this issue?
Posted by eschneider8888 on 11/12/2009 at 11:26 AM
C# seems to have an added feature for the editor; I can't imagine it would be that hard to add for VB.

See:

Options
>Text Editor
>>C#
>>>Advanced

Panel:
XML Documentation Comments

Check Box:
Generate XML Documentation comments for ///
Posted by eschneider8888 on 8/4/2009 at 6:52 AM
Is there a work around, to make it behave as it should like it does for c#?
Posted by eschneider8888 on 7/28/2009 at 8:53 PM
Why does it behave differently for c# projects?
Posted by Microsoft on 7/28/2009 at 4:46 PM
Hi,

Thanks very much for taking the time to provide this feedback. The current behavior of the "Generate XML Documentation File" option, while unintuitive, is actually by design. The primary is for performance. When the option is unchecked, the VB background compiler does not produce internal parse trees for the XML doc comments, which can positively influence the background compiler's performance. Because the parse trees are not created, the automatic XML doc comment generation is disabled in the editor because, without the parse trees, the VB IDE can't show IntelliSense in the XML doc comments.

All of that said, I completely agree that this is unintuitive and not really the best design. We should fix it. Unfortunately, we won't have time to change this for Visual Studio 2010. I am resolving this as postponed to ensure that we consider this for a future release of Visual Studio.

Please feel free to contact me directly at dustinca@microsoft.com if you have further comments or suggestions.

Kind Regards,
Dustin Campbell
Visual Basic IDE Program Manager
Posted by Microsoft on 7/27/2009 at 7:52 PM
Thanks for your feedback.

We are rerouting this issue to the appropriate group within the Visual Studio Product Team for triage and resolution. These specialized experts will follow-up with your issue.

Thank you
Sign in to post a workaround.
Posted by JK6 on 1/19/2011 at 2:23 AM
Also posted here:http://stackoverflow.com/questions/1088837/    

1) In your project properties ensure that Generate XML documention file is checked.
2) Click the Build Events button
3) Into the Post-build event command line box enter the command

Del "$(OutDir)$(ProjectName).xml"

Now after each build it will remove the XML comment file.

Note: For some reason if it exists from a previous build it will not delete it so manually delete it the first time.