Attributes pour décrire mon accesseur

[Résolu]
Signaler
Messages postés
16
Date d'inscription
vendredi 13 février 2004
Statut
Membre
Dernière intervention
12 février 2008
-
Messages postés
201
Date d'inscription
mercredi 8 février 2006
Statut
Membre
Dernière intervention
20 février 2007
-
Bonjour,

J'ai des accesseurs qui portent des noms inutilisables (me demandez pas pourquoi ils portent ce genre de nom, je suis obligé de les nommer ainsi) aussi pour simplifier le travail des développeurs je voulais ajouter un descriptif qui explique en clair à quoi sert l'accesseur.
Je cherche donc à "décorer" mon accesseur pour que dans Visual studio on obtienne un descriptif de ce que fait mon accesseur



/// <summary>
/// Identifiant du contact
/// </summary>
/// <remarks>Obligatoire</remarks>

// [Help ("Identifiant du contact")]
public
int IDCTC
{

get
{

return VGNN_IDCTC;
}



set
{
VGNN_IDCTC =
value;
}
}

Je voudrais que dans VS on ait
int IDCTC
identifiant du contact

de la même manière que pour toto.getHashCode on a
int Object.getHashCode ()
sert de fonction de hachage pour un type particulier ...

Merci

9 réponses

Messages postés
6351
Date d'inscription
samedi 1 juin 2002
Statut
Modérateur
Dernière intervention
2 août 2014
97
Salut,

/// <summary>
/// Identifiant du contact
/// </summary>
/// <remarks>Obligatoire</remarks>
public int IDCTC
{

get
{
return VGNN_IDCTC;
}
set
{
VGNN_IDCTC = value;
}
}

est bon.

Description et Category sont en rapport avec le designer "visuel" et sa PropertyGrid.
Pour faire ce que tu veux :
- si le code est utilisé au sein du même projet tu n'as rien de spécial à faire
- si le code est utilisé en ajoutant l'assembly en réf dans un autre projet, tu dois demander à VS de générer le fichier xml contenant les commentaires (Options du projet => Propriétés de configuration => Générer => Fichier de documentation XML)si ton assembly est "maDll.dll" met le nom "maDll.xml"
Ensuite tu fournis le fichier avec ton assembly et VS chargera les données.
Et on se sert aussi de ce fichier pour générer une documentation externe (voir NDoc)

Cocoricoooooooo !!!!
coq
MVP Visual C#
Messages postés
3246
Date d'inscription
lundi 25 avril 2005
Statut
Modérateur
Dernière intervention
27 octobre 2012
41
DescriptionAttribute je crois..
Messages postés
16
Date d'inscription
vendredi 13 février 2004
Statut
Membre
Dernière intervention
12 février 2008

Cela avait l'air d'être qqchose comme cela
Cependant j'ai ajouté le code ci-dessous
et j'ai toujours le tooltip "par défaut" dans VS (int monobjet.IDCTC).

J'ai essayé sur une méthode au lieu d'un accesseur et c'est idem (pas de descriptif supplémentaire)

Une idée qq1 ?
...
using System.ComponentModel;

...
/// <summary>
/// Identifiant du contact
/// </summary>
/// <remarks>Obligatoire</remarks>

[Description ("Identifiant du contact")]
public
int IDCTC
{

get
{

return VGNN_IDCTC;
}

set
{
VGNN_IDCTC =
value;
}
}
Messages postés
3246
Date d'inscription
lundi 25 avril 2005
Statut
Modérateur
Dernière intervention
27 octobre 2012
41
IL faut peut être rajouter CategoryAttribute
Messages postés
16
Date d'inscription
vendredi 13 février 2004
Statut
Membre
Dernière intervention
12 février 2008

>Description et Category sont en rapport avec le designer "visuel" et sa PropertyGrid.
>Pour faire ce que tu veux :
>- si le code est utilisé au sein du même projet tu n'as rien de spécial à faire

En effet j'avais 2 projets dans ma solution et les infos sont bien visibles dans le projet "d'origine" mais pas dans l'autre projet qui "exploite" la dll.

> - si le code est utilisé en ajoutant l'assembly en réf dans un autre projet, tu dois >demander à VS de générer le fichier xml contenant les commentaires (Options du >projet => Propriétés de configuration => Générer => Fichier de documentation >XML)si ton assembly est "maDll.dll" met le nom "maDll.xml"
>Ensuite tu fournis le fichier avec ton assembly et VS chargera les données.
>Et on se sert aussi de ce fichier pour générer une documentation externe (voir NDoc

Ca fonctionne.
Merci beaucoup
Messages postés
3246
Date d'inscription
lundi 25 avril 2005
Statut
Modérateur
Dernière intervention
27 octobre 2012
41
J'avais pas compris la question Mais comme ca tu sais aussi rajouter une description pour le designer
Messages postés
201
Date d'inscription
mercredi 8 février 2006
Statut
Membre
Dernière intervention
20 février 2007
2
J'arrive un peu tard mais peut on changer le nom qui est afficher dans le designer?
dans mon cas, j'ai ça:
[Browsable(true),CategoryAttribute("Appearance"), DescriptionAttribute("Définie l'IP par defaut de la forme 127.0.0.1.")]
Mais il affiche le nom interne à mon programme dans le designer ( stringIP ) mais je voudrais qu'il affiche comme nom que IP.
En fait, j'ai plusieur paramétre qui aboutisse à la meme chose ( stringIP, byteIP et IPAddress ). C'est pour recevoir une adresse dans différent format, donc j'ai essayé de donner des noms intuitif.
Par contre, dans le designer, je n'affiche que le stringIP (plus facile la configuration par defaut au format string..., le autre sont à Browsable(false)) mais je ne souhaite pas qu'il affiche mon nom "interne" mais plutot un nom "générique".
Savez vous si il existe un attribu pour faire ca? J'ai essayé NameAttrbute mais bien sur ca ne fonctionne pas ...

f.colo
Messages postés
6351
Date d'inscription
samedi 1 juin 2002
Statut
Modérateur
Dernière intervention
2 août 2014
97
Idée intéressante effectivement.

En .Net 2.0, tu as l'attribut DisplayName.
En .Net 1.1, il n'existe pas, il faudra l'implémenter toi même.

/*
coq
MVP Visual C#
*/
Messages postés
201
Date d'inscription
mercredi 8 février 2006
Statut
Membre
Dernière intervention
20 février 2007
2
Voici des exemple sur developez.com pour fair eces propres contrôles. Ils y parlent des attribus en autres.

http://morpheus.developpez.com/usercontrols/

C'est très bien expliqué et utilse lorsqu'on veut faire un userControl assez bien :)

f.colo