Me: I'm a relative new-comer to the .NET platform. Problem In Java, you can add package level documentation to your project by creating a package-info.java or package.html file and storing in the package folder. How do I add equivalent documentation to my project in C# using Visual Studio 2010? Background I like to write documentatio...
I would like some tool, preferably one that plugs into VS 2008/2010, that will go through my methods and add XML comments about the possible exceptions they can throw. I don't want the <summary> or other XML tags to be generated for me because I'll fill those out myself, but it would be nice if even on private/protected methods I could ...
What is the name of the tool that allowed VB.NET code to have embedded documentation comments (corresponding to C# documentation comments) that could be extracted by this tool? I am going through some old code; Visual Studio 2005 era. A trivial example is: 'Form overrides dispose to clean up the component list. ''' <summary> ''' Summ...
I've seen various questions here on SO involving Microsoft's XML documentation tags, but I'm having trouble adding some example code: /// <summary>Return the oldest acceptable timestamp for a data packet.</summary> /// <example> /// if( GetOldestValidResultTime() < lastResultTime ) /// { /// Console::WriteLine("Results are too old")...
What tool do I need to generate XML intellisense help file as shown below? ...
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! ...
I'd like a documentation tool that uses a less verbose markup. Filling my comments with XML just seems like an unnecessary eye sore, and a huge waste of key strokes should I have to edit something outside of VS. I spend a lot more time in the ruby world and would love to find something more like YARD. I have a feeling this is a pipe dr...
Hi, I'm looking for a free authoring tool to author XML Documentation in Visual Studio 2010. I know Document! X but i'm looking for a free or open-source similar tool. Any idea ? Thanks. ...
I am trying generate XML comment for my asp.net website pages. But when i right click on the website in the solution explorer i can't find Properties instead i find Propert Pages. How to get started with xml documentation? Any suggestion. More specifically here: http://msdn.microsoft.com/en-us/library/azt1z1eh.aspx ("To build the XML Do...
I am having to use the Google AdWords API for a project, I have large chunks working but I am getting frustrated with the documentation. For example I know that a TextAd headline field has a limit of 25 characters and can't have things like ! and ? in it. The documentation makes no mention of it though: http://code.google.com/apis/adword...
Visual Studio has a nice feature to spit out a bunch of compiler warnings if some of the public members are missing XML documentation. I would love to have the same for internal, or better, any non-private members, but unfortunately so far I wasn't able to find how to configure the level of visibility for which to require XML documentat...
What is the best way to document a dependency property? Should I put the xml documentation on the field: /// <summary>Documentation goes here</summary> public static readonly DependencyProperty NameProperty = DependencyProperty.Register(...) or on the property: /// <summary>and/or here?</summary> public string Name{ get{......