mskeel Posted March 23, 2004 Posted March 23, 2004 Is there a way to put intellisense documentaiton into home made custom classes? For example, looking at myhashTable.add gives the comment "adds an element with the specefied key and value..." in addition to the function defenition. Further, and this would be a huge bonus, the ability to give parameter descriptions as the user types them in. Just like for the .Net classes, only in a custom class. Quote
Arch4ngel Posted March 23, 2004 Posted March 23, 2004 Yah! And that's the coolest part ! In C# (don't know in VB.NET) you just have to type three time "/" before a function or a method and you'll have an XML comment. Just add comments to the right place and LIFT OFF ! Quote "If someone say : "Die mortal !"... don't stay to see if he isn't." - Unknown "Learning to program is like going out with a new girl friend. There's always something that wasn't mentioned in the documentation..." - Me "A drunk girl is like an animal... it scream at everything like a cat and roll in the grass like a dog." - Me after seeing my girlfriend drunk and some of her drunk friend. C# TO VB TRANSLATOR
Administrators PlausiblyDamp Posted March 23, 2004 Administrators Posted March 23, 2004 If you are using C# then you can provide XML documentation using a variant of the c-style // comment. i.e. /// /// Returns a pointless string /// /// Parameter to personalise the rubbish returned /// Utter junk is returned private string HelloWorld(string name) { return "Hello " + name; } also if you are building a classlibrary then rummage in the project properties - there is an optioin to generate a XML file that can then be used by the IDE to provide tool tips between projects and cal also be used with NDoc to produce help files. Quote Posting Guidelines FAQ Post Formatting Intellectuals solve problems; geniuses prevent them. -- Albert Einstein
mskeel Posted March 23, 2004 Author Posted March 23, 2004 what about vb? I've been doing some more searching for a possible solution in VB.net and I found a forum that mentions '@ as a way to do this xml documentation. Can anyone verify this? Also, and this may be the only real solution, Microsoft has a program that will do this. I'm not sure how it works but I am investigating... Quote
mskeel Posted March 23, 2004 Author Posted March 23, 2004 Whidbey and what is this Whidbey that I keep reading about? http://www.panopticoncentral.net/PermaLink.aspx/c3e78d5b-3673-4e56-b603-d9beb9735617 http://geekswithblogs.net/evjen/archive/2003/11/17/603.aspx Quote
Administrators PlausiblyDamp Posted March 23, 2004 Administrators Posted March 23, 2004 Whidby is the next version of Visual Studio - currently scheduled for early 2005. Some nice language / IDE enhancements in there. Quote Posting Guidelines FAQ Post Formatting Intellectuals solve problems; geniuses prevent them. -- Albert Einstein
*Gurus* Derek Stone Posted March 23, 2004 *Gurus* Posted March 23, 2004 "'@" will only work in Visual Studio .NET 2005 (Whidbey). Current versions of Visual Studio .NET won't upchuck if you use that syntax, however the comments will not be recognized as documentation, and therefore won't show up in Intellisenseless. Quote Posting Guidelines
mskeel Posted March 24, 2004 Author Posted March 24, 2004 How does it work? I've gotten the intelisensing to work for my dll and I have created an xml document by the same name, mylib.xml. How does the IDE know where to find the xml? If I wanted to give this dll to a fellow developer, for them to have the intellesense they would need the .xml file also? Quote
*Gurus* Derek Stone Posted March 24, 2004 *Gurus* Posted March 24, 2004 Yes, you would. Quote Posting Guidelines
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.