Comment créer une docstring dans VB.NET?

Question

J'écris un .dll en Visual Basic. Lorsque le code écrit dans Visual Studio si je fais quelque chose comme

Console.WriteLine(

il affiche une info-bulle avec un peu de documentation pour la fonction. Est-il possible d'écrire quelque chose dans ma fonction/sub qui fournirait cette information à Visual Studio?

Merci

Answer 1

Oui, bien sûr! Quelque chose comme:

''' <summary> 
''' Comment for method 
''' </summary> 
''' <param name="Parameter">Comment for the parameter "Parameter"</param> 
''' <remarks></remarks> 
Sub Test(ByVal Parameter As Integer) 

End Sub 

Le bloc XML documentatin doit être préfixé avec trois caractères de commentaire (guillemets simples). Vous pouvez afficher une liste de common documentation XML tags here. Le point bonus est que le compilateur peut extraire un fichier XML et le mettre à côté de votre assemblage quels outils de génération de documentation (comme Sandcastle, NDoc) peuvent utiliser pour générer automatiquement des fichiers d'aide formatés avec votre documentation API.