Wrox Programmer Forums
Go Back   Wrox Programmer Forums > Visual Basic > VB 6 Visual Basic 6 > VB.NET
|
VB.NET General VB.NET discussions for issues that don't fall into other VB.NET forums.
Welcome to the p2p.wrox.com Forums.

You are currently viewing the VB.NET section of the Wrox Programmer to Programmer discussions. This is a community of software programmers and website developers including Wrox book authors and readers. New member registration was closed in 2019. New posts were shut off and the site was archived into this static format as of October 1, 2020. If you require technical support for a Wrox book please contact http://hub.wiley.com
 
Old August 17th, 2004, 11:21 AM
Friend of Wrox
 
Join Date: Jun 2003
Posts: 540
Thanks: 0
Thanked 4 Times in 4 Posts
Default Adding descriptions to values in functions

I was wondering how to add a description to the passed values in a sub or function that I create.

So if I have function, when I start entering the parameters to pass, the description changes according to which one I am on.

Thanks as always.

J
 
Old August 17th, 2004, 12:14 PM
Authorized User
 
Join Date: Jun 2003
Posts: 63
Thanks: 0
Thanked 0 Times in 0 Posts
Default

Hi

I've seen on other news groups about this and it is possible to do this but you need to create your own xml files and keep them updated manually, from what I can gather the ide reads these xml files in, it's easier (so I've read) in C# because of the xml commenting feature, this should be a feature in VB 2005 (xml commenting that is).




Duncan
 
Old August 17th, 2004, 12:38 PM
planoie's Avatar
Friend of Wrox
 
Join Date: Aug 2003
Posts: 5,407
Thanks: 0
Thanked 16 Times in 16 Posts
Default

Yes it is simple in C#:

    /// <summary>
    /// This is the HelloWorld method
    /// </summary>
    /// <param name="strString">Pass a string</param>
    /// <returns></returns>
    public string HelloWorld(string strString)
    {
    }

Yes, this is a feature in 2005 for BOTH C# and VB.NET.
 
Old August 17th, 2004, 01:40 PM
Friend of Wrox
 
Join Date: Jun 2003
Posts: 540
Thanks: 0
Thanked 4 Times in 4 Posts
Default

OK, my next 2 questions:

Is this available to VB in 2003?

Is there an article on this somewhere?
 
Old August 17th, 2004, 02:29 PM
Imar's Avatar
Wrox Author
 
Join Date: Jun 2003
Posts: 17,089
Thanks: 80
Thanked 1,576 Times in 1,552 Posts
Default

For VB.NET, you can download the VB.NET Documenter from http://www.gotdotnet.com/team/ide/

It's a Powertoy created by the team that also created VS.NET (I think).

It's not as clean as the C# version, but it works. Last time I tested it, I got a weird error every now and then, but it works pretty well. I believe the end result is the same XML file as you would get from the C# version, so you can use tools like NDoc to generate help files.

HtH,

Imar
---------------------------------------
Imar Spaanjaars
Everyone is unique, except for me.
 
Old August 17th, 2004, 03:47 PM
Friend of Wrox
 
Join Date: Jun 2003
Posts: 540
Thanks: 0
Thanked 4 Times in 4 Posts
Default

Thanks. I will look at it. :)





Similar Threads
Thread Thread Starter Forum Replies Last Post
adding up values in xslt northwind XSLT 21 February 17th, 2017 09:07 AM
Adding the values within an array Dave_Richards Beginning PHP 0 November 8th, 2006 04:34 PM
Adding Values NeilS21 Beginning VB 6 1 February 6th, 2004 10:45 AM
Adding prototype functions AgentSmith Javascript How-To 1 July 20th, 2003 09:41 AM





Powered by vBulletin®
Copyright ©2000 - 2020, Jelsoft Enterprises Ltd.
Copyright (c) 2020 John Wiley & Sons, Inc.