How to add small descriptions to Functions

Menol_LK · #1 11-Jan-2007, 01:44

Hi Friends,

I want to add descriptions to functions that I write (specially in the common classes to be used by other programmers).

What I mean by this is ...

when we are using an .Net function, or a sub proc. it displays a small description
(in that small yellow colored box)
which describes the usage

for ex/
if we use something.ToString(), a description saying "Converts to String ....
..." in a small yellow colored box
and also it describes each parameter whereas in a normal function creation, only the parameter type is displayed in that yellow box.

I know this can be done But I just dont know how... !

Please Help Me.

-- Menol --

erniegerdie · #2 19-Jan-2007, 03:42

Quote:

Originally Posted by Menol_LK

Hi Friends,

I want to add descriptions to functions that I write (specially in the common classes to be used by other programmers).

What I mean by this is ...

when we are using an .Net function, or a sub proc. it displays a small description
(in that small yellow colored box)
which describes the usage

for ex/
if we use something.ToString(), a description saying "Converts to String ....
..." in a small yellow colored box
and also it describes each parameter whereas in a normal function creation, only the parameter type is displayed in that yellow box.

I know this can be done But I just dont know how... !

Please Help Me.

-- Menol --

Type three forward slashes '///' just above your method.
The Visual Studio IDE will then insert a a comment header to your method, you can then type in the descriptions for the parameters and the methods.

i.e

C-SHARP / C# Code:

        /// <summary>
        /// -->> Enter your comments here <---
        /// </summary>
        /// <param name="state">--> You can also enter descriptions for the parameters <-- </param>
        private void HarvestDeadThreads(object state)
        ....

Now when you however over calls to the method you should see the summary.

If your interested there is also a tool called GhostDoc which you can use to assist in creating your own pre-defined generic descriptions for method summaries, which is determined by the names of names and the parameters.

You can get it here:
http://www.roland-weigelt.de/ghostdoc/

Enjoy

Menol_LK · #3 19-Jan-2007, 05:24

Friend,

Thnx a lot,
and do you know a way to achive this in VB.NET.

Thanks again!

-- Menol --

Thread Tools	Search this Thread
Show Printable Version Email this Page	Search this Thread: Advanced Search
Rate This Thread
Rate This Thread:

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Windows C++ Problem with Class and Functions	Alloishus	C++ Forum	3	28-Sep-2006 19:34
friend functions error	CaptnB	C++ Forum	2	12-Jun-2006 14:39
Re: Using APC functions in your PHP scripts	admin	MySQL / PHP Forum	0	12-May-2006 00:43
Please help with functions...	brookeville	C++ Forum	36	05-Nov-2004 01:23
conflict between printf and stdarg.h va functions	mirizar	C Programming Language	3	12-Jul-2004 09:11

How to add small descriptions to Functions

Re: How to add small descriptions to Functions

Re: How to add small descriptions to Functions