Nate Bross Posted February 15, 2006 Posted February 15, 2006 I was just wondering if there is a way to put information in the tool tip that appears when you are typing the param list for an overloaded method when you are the one writing the overloaded method. eg. public void Move(Point pos) { iSpriteX = pos.X; iSpriteY = pos.Y; } public void Move() { Move(new Point(iSpriteX + iSpeedX, iSpriteY + iSpeedY)); } Is there a way to put a description of the variable at the bottom of the tooltip, as seen in most .NET overloads? Quote ~Nate� ___________________________________________ Please use the [vb]/[cs] tags on posted code. Please post solutions you find somewhere else. Follow me on Twitter here.
Cags Posted February 15, 2006 Posted February 15, 2006 Assuming you mean what I think this can be achieved by typing three slashes (///) before a method... this will automatically make the following appear. /// <summary> /// What method does /// </summary> /// <param name="myParam">What parameter is</param> /// <returns>what the method returns</returns> public string MyMethod(string myParam) { } Quote Anybody looking for a graduate programmer (Midlands, England)?
Leaders snarfblam Posted February 15, 2006 Leaders Posted February 15, 2006 These are called code comments. Code comments are compiled into an XML file, in the same format as the tool tips for the .Net framework. Quote [sIGPIC]e[/sIGPIC]
Nate Bross Posted February 15, 2006 Author Posted February 15, 2006 Okay, that's exactly what I was talking about. Is there a way to do this with Visual Basic? Quote ~Nate� ___________________________________________ Please use the [vb]/[cs] tags on posted code. Please post solutions you find somewhere else. Follow me on Twitter here.
mskeel Posted February 15, 2006 Posted February 15, 2006 In VS2005 you can now use ''' the same way /// is used in C#. If you're using VS2003, you need to use an external tool, either a VS add-in or VBCommentor Don't forget that you can also use NDoc to createa sweet looking API for your libraries if you want to as well. Quote
Recommended Posts
Join the conversation
You can post now and register later. If you have an account, sign in now to post with your account.