XML comments schema customization in C#
Allow to customize the XML tags recommended for use in XML inline comments for documentation.
Just as in VB, a CSharpXMLDoc.xml could be saved in AppData to pass C# editor the customized XML elements.
This would be a really great feature. If at the very least, the ability to customize available tags via an attached xml doc that Visual Studio picks up would be swell :)
I also think that if plausible, the ability to add some features to increase it's functionality and usability such as snippet support (to be able to grab values from the entity being documented) could really drive home the use of this feature instead of it being ignored.
See the following 2 links for more information on how it works currently in the VB.NET IDE enviornment:
Hendrik Bulens commented
I'm very surprised that this isn't included in VS 2015 yet. VB is ahead of C#, what year is it?
Shocked that VS2015 didn't add this still..
I agree that we need the ability to modify the C# templates, snippets, etc., for both code and comment items, and the mechanism should give us the ability to insert replaceable parameters throughout. I too was surprised that this appears to have not been implemented.
I would like to have a "history" tag that automaticaly contains the current date
Yes, please allow C# to customize the XML comments schema. And to go a little further, allow us to change pre-parsing steps, so we can have a kind of CDATA handling for the standard tags like <summary> and <example>, which so often I need to include symbols like ">" or "<" and have nice indenting and line spaces and I really don't want to have use escape codes, or break the XML comment up, etc.
Timothy Huber commented
I just want to change the template to a one-liner instead of three. If I want more lines I can hit enter.
Dmitriy Melnik commented
I would like to add fields to the basic xml comment template in CS
+1 for some type of implementation for C#. I was looking for this to solve a problem I have currently. Now I'll have to do it the hard way!! :(
Roberto González commented
I would also like to add fields to the basic xml comment template in CS
Please either a) allow customisation or b) as a minimum improve the templates so they impliment documentation properties demanded by stylecop...
Must have feature for Visual studio 2013 to generate REST/SOAP API documentation with error codes
Me to interested in documenting ErrorResponse for integrating with swagger UI feed
John Willemse commented
I couldn't believe this was not a implementable feature yet.
I want this so I can automatically create and fill in the <remarks> block with info I am repeatedly typing.
Todd Morrison commented
+1 for me.
I have a good set of rest services that generate a Swagger UI feed using ASP.NET WebApi.
Since the documentation for rest services extend far beyond what is available in the existing code doc spec, it would be nice to add in custom fields.
Examples of fields I have had to parse out of the summary:
<ErrorResponse code="404" message="Resource not found" />
<ErrorResponse code="300" message="blah blah, i think you get it" />
jian Yao commented
Yes, I like this idea.
Yes, we need the ability to easily add "new" tags to the comment template.