Commentaires en POO [Résolu]

Signaler
Messages postés
206
Date d'inscription
samedi 17 janvier 2009
Statut
Membre
Dernière intervention
5 mars 2013
-
Messages postés
206
Date d'inscription
samedi 17 janvier 2009
Statut
Membre
Dernière intervention
5 mars 2013
-
Bonsoir,

J'aurais besoin de quelques precisions sur l'utilisation des commentaires en POO.

Par exemple dans le code suivant, quel genre d'information peut-on normalement mettre/utiliser pour <value>, <returns> et <remarks>, et quels avantages on en tire?

''' <summary>
''' Customer for this Project
''' </summary>
''' <value></value>
''' <returns></returns>
''' <remarks></remarks>
<XmlElement("Customer")> _
Public Property pCustomer() As String
       Get
           Return _pCustomer
       End Get
       Set(ByVal value As String)
           _pCustomer = value
       End Set
End Property


Peut-etre une question bete, mais je la pose quand meme!

Pour <Summary>, c'est une information qu'on retrouve dans l'intellisense, mais pour les autres, cela me parait moins evident.

A+
JLuc01

2 réponses


Bonjour,

''' <value></value>

Pour une classe c'est la valeur par défaut de la propriété
Pour une une sub ou une function ordinaire c'est la valeur d'une variable, d'une constante ou d'un paramètre

''' <returns></returns>
Pour une fonction c'est le but du calcul ou le résultat attendu

''' <remarks></remarks>
Un commentaire général ou une information spéciale qui peut être utile pour le reviseur ou l'utilisateur. Par exemple une "passe spéciale ou le nom du programmeur ou la date de mise en service ou de la révision

et quels avantages on en tire?

Cela fait partie de la documentation. Regarde dans tes projets, tu devrais trouver un fichier xml qui porte le même nom que ton projet. Ouvre-le après avoir rempli une zone de commentaires.
Messages postés
206
Date d'inscription
samedi 17 janvier 2009
Statut
Membre
Dernière intervention
5 mars 2013
1
Bonjour,

Et merci, cela m'eclaircit un peu plus sur ces commentaires en POO.
Mais le chemin d'apprentissage en POO est encore long.

A+
JLuc01