autocomplete tool-tips

[kmfna]

Hello all,

I was curious if there is a way to add your own tooltips for autocomplete. For Example, if type "string." and select "Empty", you see: "string String.Empty Represents the empty string. This field is read-only." So I was wondering if there is a tag that will display comments like this for user created functions/objects?

Thanks in advance!
-Kevin

- "The truth hurts, maybe not as much as jumping on a bicycle with no seat, but it hurts.

 

[MadJock]

Hi Kevin,

If I understand correctly, you want Intellisense for classes / methods that you've developed?

If that's the case, this is achieved using xml comments. In the project properties, (Build tab), specify an XML output file.

If you release this with your DLL, anyone using your DLL will get the intelli-sense.

Hope this helps,

Graeme

/// <summary>this is an XML Comment</summary>
public class MyClass{

  /// <summary>Does something</summary>
  ///<param name="myParam">Description of MyParam</param>
  public string MyMethod(string myParam){
    // do something
  }

}

"Just beacuse you're paranoid, don't mean they're not after you

 

[kmfna]

Hey Graeme,

You were exactly correct. Even though I had done a lot of searches, I had not put together that the xml comments were used this way, but I did happen upon a white paper about it last night, but have yet to give it a shot.

Thanks for your help, though!!
-Kevin

- "The truth hurts, maybe not as much as jumping on a bicycle with no seat, but it hurts.

 

[chiph]

Some utilities that you may want to look at, once you have your XML comments in place:

NDoc -- turns your XML comments into MSDN style help, which can be integrated into your help collection.

GhostDoc -- right-click on the method header and select "Document this", and it does an excellent job of looking at the method name and coming up with decent comments. If it does something you don't like, you can change it's rules to conform with your naming convention.


____________________________________________________________________
If you want to get the best response to a question, please read FAQ222-2244 first

 

[kmfna]

Ahhh...chiph - the man the myth the legend!

Your bring up a good point, that is definitely a great idea! I was mostly just wanting it for development (though I still haven't figured out why I can't see the comments in other projects (ie. when I include this project in another), but thats out of the scope of this thread).

Thanks a bunch!
-Kevin


- "The truth hurts, maybe not as much as jumping on a bicycle with no seat, but it hurts.