Jump to content
Xtreme .Net Talk

Recommended Posts

Posted

Hi all,

 

Is there a way to add the descriptive text of a custom method that I create, like the ones that appear when you select a method or property from the IDE?

 

Thanks,

 

Chris

if(computer.speed == "slow")
    {  
       hamster.feed();  
    }
if(computer.speed == "really slow")
    {  
        hamster.kill();
        BuyNewHamster();
    }

Posted (edited)

Visual Studio has an xml documentation parser built in for C#.

 

Simply press / 3 times (///) before methods and classes and the summary documentation tag appears

 

You can download third party tools for xml documentation support in vb.net

 

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html/vclrftagsfordocumentationcomments.asp

 

http://dotnet.mvps.org/dotnet/faqs/?id=tooltipsxmldocumentation&lang=en

Edited by Diesel
Posted (edited)

Works like a charm. One thing though, it's 3 /// instead of 3 \\\

 

Thanks for the "tip"

 

Chris

Edited by dakota97
if(computer.speed == "slow")
    {  
       hamster.feed();  
    }
if(computer.speed == "really slow")
    {  
        hamster.kill();
        BuyNewHamster();
    }

Posted
Ok, I must've been dyslexic when I first read that reply....lol
if(computer.speed == "slow")
    {  
       hamster.feed();  
    }
if(computer.speed == "really slow")
    {  
        hamster.kill();
        BuyNewHamster();
    }

Posted
Also, if you are interested, NDoc is a really awesome tool that will convert your XML inforomation file into an MSDN style documentation webpage. Really cool if you are developing libraries that you share with other developers.

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • Create New...