Доброго времени!
Не подскажете как дать описание свойству/методу класса? Написал свой класс и теперь надо, чтобы в ObjectBrowser'е можно было читать описание

Спасибо,

guest00 wrote:
> Доброго времени!
> Не подскажете как дать описание свойству/методу класса? Написал свой
> класс и теперь надо, чтобы в ObjectBrowser'е можно было читать
> описание

Тебе нужно создать XML-файл:

Adding tooltips in intellisense for VB.NET assemblies and creating HTML Help documentation:

VS.NET takes the text shown in intellisense tips from an XML file that is provided in addition to the assembly (for example, a DLL). The XML file must have the same name as the corresponding DLL with .xml" appended and has to be placed in the same folder as the assembly (assembly "Foo.dll", XML file "Foo.dll.xml").

The format of the XML file taken by VS.NET is specified here:

<URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfprocessingxmlfile.asp&gt;

For C#, VS.NET creates this XML file automatically (compiler option "/doc").
For VB.NET, that's currently not supported, but this will be possible in VB 2005.

You can create the XML file by hand, but notice that this will take a lot of time and it will be hard to keep the file up to date when parts of the assembly change. It's much easier to use one of the tools listed below to create the XML file. Tools like NDOC will take the XML file and create an HTML Help file from the XML formatted data.

One easy way to create the XML file is to provide information for tooltips as XML comments inside the VB.NET source files and then use tools like VB.DOC to create the XML file that contains the data. Then you can copy this file into the assembly's directory to provide information to VS.NET that enables it to display tooltips, or you can create a help file. The help file can be deployed with the assembly and can be used by other developers who use the assembly as reference.

For VB.NET 2002/2003:

VB Commenter
<URL:http://www.gotdotnet.com/team/ide/&gt;
-> "VB Commenter"

XML Documentation
<URL:http://www.gotdotnet.com/team/vb/&gt;
-> "XML Documentation"

VBXC — VB.NET XML Commentor
<URL:http://vbxmldoc.tor-erik.net/&gt;

NDOC (formerly DOC.NET)
<URL:http://ndoc.sourceforge.net/&gt;

VB.DOC
<URL:http://vb-doc.sourceforge.net/&gt;

<URL:http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd&gt;

XML comments will be introduced to VB in version 2005 ("Whidbey").

C# XML comments:

C# Programmer's Reference -- Recommended Tags for Documentation Comments
<URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfTagsForDocumentationComments.asp&gt;

Здравствуйте, guest00, Вы писали:

G>Не подскажете как дать описание свойству/методу класса? Написал свой класс и теперь надо, чтобы в ObjectBrowser'е можно было читать описание

Для VB6: меню Tools -> команда Procedure Attributes...

Здравствуйте, Peter Fleischer, Вы писали:

PF>guest00 wrote:
>> Доброго времени!
>> Не подскажете как дать описание свойству/методу класса? Написал свой
>> класс и теперь надо, чтобы в ObjectBrowser'е можно было читать
>> описание

PF>Тебе нужно создать XML-файл:

Неужели все так запущено
Он действительно обидели поклонников Васика!

guest00 wrote:
> Здравствуйте, Peter Fleischer, Вы писали:
>
> PF>guest00 wrote:
>>> Доброго времени!
>>> Не подскажете как дать описание свойству/методу класса? Написал свой
>>> класс и теперь надо, чтобы в ObjectBrowser'е можно было читать
>>> описание
>
> PF>Тебе нужно создать XML-файл:
>
> Неужели все так запущено
> Он действительно обидели поклонников Васика!

Жди Visual Studio 2005. Там все будет аналогично C#. Вместо /// на ставить в прог вб только '''

Peter

Здравствуйте, Vi2, Вы писали:

Vi2>Здравствуйте, guest00, Вы писали:

G>>Не подскажете как дать описание свойству/методу класса? Написал свой класс и теперь надо, чтобы в ObjectBrowser'е можно было читать описание

Vi2>Для VB6: меню Tools -> команда Procedure Attributes...

В том то и дело, что меня призвали в армию .Net
Приходится немного переучиваться. Вот и решил по-старинке воткнуть описание своих методов, свойств и событий, чтобы друг/враг/я сам через год разобраться что какой метод делает...
И вот на тебе, оказывается все не так уж просто как два байта по сети

Здравствуйте, Peter Fleischer, Вы писали:


PF>Жди Visual Studio 2005. Там все будет аналогично C#. Вместо /// на ставить в прог вб только '''

PF>Peter

Спасибо!

Придется опять про тонкости C# книгу из шкафа вытаскивать
Уж лучше я последую "тонкому" намеку от Майкрософт, как и делал последние несколько лет, и продолжу работу с С.Шараповым

guest00 wrote:
...
> Придется опять про тонкости C# книгу из шкафа вытаскивать
> Уж лучше я последую "тонкому" намеку от Майкрософт, как и делал
> последние несколько лет, и продолжу работу с С.Шараповым

Бери то, что лучше умеешь. Разница между VB.NET и C#.NET настолько маленькая, что не стоит о gпереходе думать. Не думаю, что специалист по C#.NET перходит без внешнего давления на VB.NET, потому ему не хватает CreateObject. А оформить VB.NET-программу с коментарием аналогично C#.NET и потом применить соответствующий AddIn для создания XML-файла тоже не проблема.

Peter