Creating Documentation and code description

normanordas

Hi Guys can you help me with this: 1. How can I create an on-the-fly documentation generation for my codes so that when i compile my application the documentation is written in an html file? 2. How can i create my own description of the method i defined in my class such that when i call this method a TOOLTIP will come out exposing the Description i wrote for that particular method. Just like the members of any class in any assembly. When you press period (.) the members will come out and a tooltip will be displayed categorically showing the signature, return type and purpose for this method. Tnx a lot!

4 Replies

Know the answer? Post it — somebody with the same question will find it here.

kevint22y ago
Take a look at NDoc. It can convert your xml documentation file into an MSDN-style help file. It is a free, open-source project. Also, XML comments are not currently supported in VB.NET, but they will be in VS.2005 (Whidbey). Regards KevinT
manoj_kv22y ago
How can we add our own description to project after the documentation is created from (tools-> web comments page) XML document? Thanks in advance.
normanordas22y ago
tnx a lot. Do you know the equivalent in VB.Net? :)
ssswamii22y ago
1. Go Tools->Build Comment Web Pages from inside Visual Studio. The generated documentation, however, is sub par. Alternately, you might find NDoc useful (http://ndoc.sourceforge.net/wiki) 2. Use the XML documentation built into Visual Studio; just type 3 forward slashes, ///. For example, ///
/// You will see this text in the tooltip! ///
/// This text will be seen as the parameter description in the tool tip! public void SomeTest(int someInt) { } That will make Visual Studio show tool tip descriptions for your method, for that particular project. If you want to make your comments of your methods show up in other projects outside your current one, right click on your project->settings->configuration properties. In the "Xml documentation" tab, put the name of your assembly, suffixed by .xml. For example, "myProgram.exe.xml" or "myLibrary.dll.xml".