Discussion :

[Kiboumz]

Bonjour,

J'aimerais savoir s'il existait un moyen de documenter nos fonctions.

Je m'explique, j'aimerais que quand j'appuie sur le "." d'une de mes classes et que je vois toutes les fonctions disponibles voir quand je sélectionne une fonction sa description...

EX :

class Test
function allo()
end function
End class

J'aimerais voir apparaître pour la fonction allo : Cette fonction retourne un message de bienvenue ...

EX 2 :
dim s as string
s.length, la description m'affiche : Get the number of ...

En faites, je voudrais faire la même chose, sauf avec mes propres fonctions!

Voilà, j'espère avoir été clair!

Merci
a+

[Nip]

tu utilises la notation suivante:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
/// <summary>
        /// Description de ta fonction
        /// </summary>
        /// <param name="NomParam">Description du parametre</param>
        /// <param name="NomParam2">Description du parametre2</param>

Jette un oeil aussi du cote de GhostDoc, ca te fera gagner un peu de temps .

[Kiboumz]

Salut,

Tu es certain que c'est cette syntaxe ? Cela ressemble plutôt
a une syntaxe pour du c# et non vb.

Merci
a+

[BassBeat]

En fait, faut remplacer les slashes par des apostrophes. Et tu écris tout ça avant le code de ta fonction.

Exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
 ''' <summary>
 ''' Effectue la somme de deux entiers.
 ''' </summary>
 ''' <param name="Entier1">Premier nombre.</param>
 ''' <param name="Entier2">Nombre à ajouter au premier.</param>
 ''' <returns></returns>
 ''' <remarks></remarks>
 Public Function Somme(ByVal Entier1 As Integer, ByVal Entier2 As Integer) As Integer
  Return Entier1 + Entier2
 End Function

[Kiboumz]

Salut,

Merci beaucoup c'est exactement ce que je recherchais!!

Aussi, dans le même ordre d'idées, y-a-t'il une façon de générer une documentation externe un peu comme avec javadoc et si oui comment ?

Merci
a+

[matrix_ceg]

Il y a ndoc mais perso j'arrive po a le faire fonctionner avec vb2005 et le Ghost Doc mentionné plus haut semble n'être que pour c#.

Du moins pour activer la fonction VB sans C# ça semble impossible.

(je ne demande pas mieux que de me tromper si quelqu'un en sais plus...)

[vilcoy]

Une astuce pour aller plus vite : au niveau de ta déclaration de fonction, tu fais clic-droit + Insert Comment et ça te génère le petit paquet de commentaires que tu n'as plus qu'à remplir.