.NET

Как вписать комментарий в пользовательский метод?
Родные классы\методы включают в себя комментарии, которые при наведении мыши показываются в строке подсказки. Можно ли вставить мои комментарии в метод\класс\тип?



Для С# и C++ модель такая:
В коде перед объявлением методов, классов или, там переменных, вставляются комментарии вида:

///<summary>
/// This method bails user off the system or ensures
/// that he(she) not going to get there anymore.
///</summary>
///<param name=userID>Delinquent user ID</param>
public void BailOff(int userID) {...}

С момента создания этого комментария VS уже с готовностью демонстрирует подсказки в подсказках IntelliSense в любом месте решения (Solution). Если же надо, чтобы подсказки были видны и далее, когда сборка уже собрана и используется в готовом виде из других сборок, то все эти комментарии экспортируются в xml с помощью специальной опции компилятора /doc (напомню, речь идет о С#). В результате создается xml со структурой вида:

<?xml version="1.0"?>
<doc>
<assembly>
<name>organismbase</name>
</assembly>
<members>
<member name="T:Action">
<summary>
<para>
This class defines common properties for all commands/actions that can
be assigned to a creature. These actions include movement, reproduction,

eating, attacking, etc...
</para>
</summary>
</member>
<member name="P:Action.OrganismID">
<summary>
<para>
The ID of the creature requesting the action. This will always be the
GUID/ID for your creature.
</para>
</summary>
<returns>
System.String of the GUID/ID for the organism requesting the action.
</returns>
</member>
...

И теперь достаточно положить этот xml рядом со сборкой, чтобы IntelliSense начал показывать подсказки по всем описанным элементам.

Теоретически поведение сборки не зависит от того, на каком языке были исходники, так что можно предположить, что если рядом со сборокой, написанной на vb, положить правильный xml, то IntelliSense будет все равно, из какого языка она произошла. Проблема только в том, что xml придется писать ручками, либо с помощью add-in'ов сторонних фирм.
Но в VB 2005 уже имеется встроенная поддержка XML-комментариев.