I have turned on warnings as errors and now i need to XML comment all of my public methods. just to get my program compiling, i just want to put placeholders for now. Is there anyway to automatically add XML comments to all of the public members in a class or a file. I see ghost doc which gives you good autogenerated XML comments but...
Hi, I was wondering if it is possible to reference a dynamic generic class name in a comment and have it conditionally resolved in the IDE? Simple base class example: // <summary> // Retrieves all <T> members from the database. // </summary> public void GetAll<T>() { //magic } If I now inherit from this class and happens to be clas...
Hi I prefer to browse the assemblies using reflector even though i have source code with me specially in case when i move to new project. But I feel it would be nice if i could see the XML comments of the source code in reflector. Is any addin which would do that? Thanks In advance, Uday ...
Is it possible to generate a set of wiki pages from XML comment file generated by Visual Studio? I'm talking about something like Sandcastle, but for wiki format instead of compiled CHM. Edit: I'm using MediaWiki which can import/export articles in XML. So I hope that it is possible to write a transformation converting XML comments t...
In my Visual Studio 2008 project, I have this project with Resources.resx which contains images and strings. In order to force myself and everyone else to write at least the XML comments, I enabled the generation of XML comments in the build tab of the project's property. Now Visual Studio gives me some warnings if there are undocumented...
When in VS 2008 if a developer hits the ''' it generates the XML comment tags for you, but this only works when the project setting for "Generate XML documentation file" is checked. Is there a way to tell VS to generate the XML Comment tags, regardless of the project setting? I think it is possible that someone may want comments but no...
I use NDoc 1.3.1 to generate documentation in VS .NET 2003, framework v1.1. For the following block /// <example> /// <code lang="C#" escaped="true"> /// try /// { /// // ... /// } /// catch (Exception ex) /// { /// // ... /// } /// </code> /// </example> in the code file, NDoc produces the contents in the <code> block formatte...
Dear ladies and sirs. Have you noticed that for some methods in the system assemblies, the .NET Reflector also shows the respective documentation? Which means that the documentation can be persisted in the assembly metadata. How can I make it work for my own assemblies? Meaning, I want to see my comments to my method when I reflect it ...
I have been using XML comments to document my source code in VB.Net (and C# when I get to). I seem to remember someone telling me a long time ago that there was a way to automatically export the XML comments into a text document or other format for easy reference outside of Visual Studio. Is there? What is it, or are they? Thank you in ...
Hi, i was wondering if there is an plugin, addon or any other easy way to get rid of the bloated xml comments for c#? Company wants the documentation, but in my daily work the comments are simply polluting the code. It would be nice to have an easy way to simply collapse all xml documentation before the methods to one line or even bette...
I am trying to get VB.NET XML Comments to work with IntelliSense, and maybe it doesn't work the way I think it does. ''' <summary> ''' Gets or sets the Patient Code. ''' <list type="bullet"> ''' <listheader><description>Validation:</description></listheader> ''' <item><description>Field Required</description></item> ...
In the below code in xml documentations there is mismatch between the names of parameters in method's arguments and name of parameters in xml documentation. Is there any way to auto correct the xml documentation signature or any feature provided in resharper to auto correct the xml documentation. #region Get Images /// <summary> /// G...
In the following example, & and Δ are OK but Δ is not (the latter two are both ). The compiler issues a warning similar to: warning CS1570: XML comment on 'XXX.DocumentedMethod()' has badly formed XML -- 'Reference to undefined entity 'Delta'.' /// <summary> /// & Δ Δ /// </summary> publ...
I'm using Visual Studio 2008 SP1 in VB.NET, when I type ''' above a function, some automatic default XML comments appear: ''' <summary> ''' ''' </summary> ''' <remarks></remarks> I would like this to be the following instead: ''' <summary></summary> ''' <remarks></remarks> Is there a way to change what appears when you type ''' a...
Consider: /// <summary> /// This method does something... /// </summary> public void DoSomething() { // code... } When using that method/class etc.. in a different dll the comments do not show up. I've tried a few things - any ideas? Thanks ...
I have XML in the following format which I want to reformat: <blocks> <!-- === apples === --> <block name="block1"> ... </block> <!-- === bananas === --> <block name="block2"> ... </block> <!-- === oranges === --> <block name="block3"> ... </block> </blocks> My problem is I can't figu...
I want to start using XML-Documentation of my code and am desperately searching for an up-to-date (meaning .NET-3.5 SP1) to do so. I found NDoc, but it only supports .NET-1.1 and that a little bit far away ;-) Any suggestions? ...
Hello, I am currently a programming student, and obviously my question is simple, but I haven't been able to find the answer to it online. So here it is: In XML /// comments in C#, where does the <returns> tag show up, I know that everything contained in the <summary> tag shows up in intellisense when you hover your mouse over your m...
What is the best practice in documenting classes and interfaces. Say if you have a concrete class called Foo, that derives from an interface called IFoo. Where do you put your comments for your methods? Do you duplicate your comments on the Interface as well as the concrete class? Here is an example where comments are duplicated: pu...
I've written a small utility that allows me to change a simple AppSetting for another application's App.config file, and then save the changes: //save a backup copy first. var cfg = ConfigurationManager.OpenExeConfiguration(pathToExeFile); cfg.SaveAs(cfg.FilePath + "." + DateTime.Now.ToFileTime() + ".bak"); //reopen the original c...