How do I escape keywords in XML comments like "note" in Visual Studio? e.g. /// See note re Create method attached to this type. I don't want the text after the word "note" to turn blue. Note this may be a Resharper feature. ...
It appears that not all Xml-Commenting shows up in Intellisense, but perhaps I am not doing it correctly? Anyway, I am trying to make it so that individual enumeration members in an enumeration list show up in intellisense with descriptive text. For example, in the String.Split method, the third overload takes the StringSplitOptions en...
Hey, So you know how your able to define a method comment such as /// <summary> /// Finds the site and information by site ID. /// </summary> /// <param name="siteID">The site ID.</param> /// <param name="customerLink">The customer link.</param> /// <returns></returns> public static Site FindSiteAndInformat...
I'm generating a class from an interface using T4 templates, and I want to be able to copy xml-comments from the interface to the class methods. Is it possible and if yes, how? In my template I am just taking the interface methods and copying them like this: foreach(var m in typeof(IFrontEndService).GetMethods()) { <#= "Some out...
Is there a point in writing comments in code like this? /// <Remarks> /// Name of abc - public property. /// </Remarks> In visual studio, the intellisense has icons for each type of class member (field, property, etc), so I don't see the point of this. In my current shop we are only using Visual Studio anyway, which provides those ico...
I am visiting some old code, and there are quite a few events declared with delegates manually rather than using EventHandler<T>, like this: /// <summary> /// Delegate for event Added /// </summary> /// <param name="index">Index of the item</param> /// <param name="item">The item itself</param> public delegate void ItemAdded(int index, ...
We have a C# project which for historical reasons uses both Doxygen and Visual Studio style comments in the same code. Has anyone tried to systematically translate one standard to another, preferably to the common XML subset? I guess it would not be too difficult to write a script to cover the most common features, but I would not like...
According to this article, it's possible to get multiline XML comments -- instead of using ///, use /** */. This is my interpretation of what multiline comments are, and what I want to have happen: /** * <summary> * this comment is on line 1 in the tooltip * this comment is on line 2 in the tooltip * </summary> */ However, when ...
I can't understand the virtues of using XML comments. I know they can be converted into nice documentation external to the code, but the same can be achieved with the much more concise DOxygen syntax. In my opinion the XML comments are wrong, because: They obfuscate the comments and the code in general. (They are more difficult to read...
I am trying to build a list for my XML comments on my C# method. I am using the following document, however the list implementation in this does not work for me. I am using visual studio 2008 and .net 3.5. http://msdn.microsoft.com/en-us/magazine/cc302121.aspx How do I build a list using XML comments in C#? Here is my current XML cod...
I have a given XML document (structure can not be changed) and want to get the comments that are written above the nodes. The document looks like this: <!--Some comment here--> <attribute name="Title">Book A</attribute> <attribute name="Author"> <value>Joe Doe</value> <value>John Miller</value> </attribute>...
I want to put an comment in web.config file, something like this: <httpRuntime requestValidationMode="2.0" // require for [ValidateInput(false)] in .net-4.0 requestPathInvalidCharacters="" // include & character in the url enableVersionHeader="false" // disable X-AspNet-Version header /> Is there any way to put co...
I work in a team where we use extensive ruleset in StyleCop and I am wondering what are the thoughts on the general point where such a tool stops being useful and starts becomes annoying. We also use GhostDoc so code is riddled with XML comments which make the code much harder to read and thus review. I have no problem with XML comments ...
Hi I have a WCF service and commenting my operation contracts as below: /// <summary> /// Call to topup a card. /// </summary> /// <param name="topUp">The TopUp object which specifies the card to topup.</param> /// <returns>Returns a boolean indicating whether call has finished successfully. </returns> [...
As the title says, my XML auto-comment feature (/// or ''') has stopped working! Spent half an hour trying to find it in Tools/Options/Environment, Googled it, rebooted, etc still no luck :-( Anyone knows where it is please? ...
Hello everybody Below comment is just a piece of xml comment in VS but my problem is characters like < > that break the xml structure. How can I use them in an xml comment? /// <param name="index">square index on board which 1<=index<=64</param> ...
Just like Ghostdoc is there any add-in for Visual Studio 2008 that can automatically add XML comments for private variables, as Ghostdoc and few others doesn't support private variables. ...
Is the code below valid XML? <sometag attribute1="value1" <!-- attribute2="value2" --> attribute3="value3"> </sometag> ...
How can one enable/achieve XML comments for C++ methods ala C# and VB in Visual Studio 2010? It appears this functionality isn't enabled/available by default. Targeting initially managed C++ projects. ...
Suppose in Visual Studio I have a new project which contains some of the same APIs from an older project, and I would like to copy the xml documentation over to the new one. Is there a way I can do this without manually copy-pasting them one by one? Thanks! ...