Tek-Tips is the largest IT community on the Internet today!

Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!

  • Congratulations MikeeOK on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!

Commenter

Status
Not open for further replies.

ksbrace

Programmer
May 13, 2000
501
US
Hi, Does the VB Compiler have documentation creation capabilities? In C#, you can do:
Code:
public class MyClass{
	/// <summary>
	/// <param name = cszMessage> The message to be displayed.</param>
	/// <param name = lDeviceNo> Device to be printed on</param>
	///</summary>
	public void DisplayMessages(string cszMessage,long lDeviceNo)
	{
	}
}

and it will generate some documentation about the class and methods, constants, etc.

 
No.

The C# compiler stores this information in an xml file parallel to the exe/dll. You can write the xml file by hand and obtain the same functionallity (provide descriptions of properties and methods for the intellisense).
If you find that a little too much work, see
Sunaj
'The gap between theory and practice is not as wide in theory as it is in practice'
 
There are add-ins available for VB. one that I use is VBxc .. go to good and type it in, the click on the first link. works really well. you put ''' and it creates the comments like C# and compiles documentation along with it
 
It is a little ways off but the new VB.net (Whidbey) does have the documentation creation capabilities just like C#.

It is in Alpha Now.



DotNetDoc
M.C.S.D.
---------------------------------------

Tell me and I forget. Show me and I remember. Involve me and I understand.
- Anonymous Chinese Proverb

-----------------------------------

If you can't explain it simply, you don't understand it well enough.
- A. Einstein
 
Status
Not open for further replies.

Part and Inventory Search

Sponsor

Back
Top