Pourquoi / quand serait-il approprié de remplacer ToString?

il est question de bonne pratique autant que n'importe quoi, vraiment.

ToString() est utilisé dans de nombreux endroits pour retourner une représentation string d'un objet, généralement pour la consommation par un humain. Souvent, cette même chaîne peut être utilisée pour réhydrater l'objet (pensez à int ou DateTime par exemple), mais ce n'est pas toujours donné (un arbre par exemple, pourrait avoir une représentation de chaîne utile qui affiche simplement un nombre, mais clairement vous ne pouvez pas utiliser cela pour reconstruire).

en particulier, le débogueur va l'utiliser pour afficher la variable dans les fenêtres de montre, fenêtres immédiates, etc, donc ToString est réellement inestimable pour le débogage.

en général, aussi, un tel type aura souvent un membre explicite qui renvoie aussi une chaîne. Par exemple, une paire Lat / Long pourrait avoir ToDecimalDegrees qui renvoie "-10, 50" par exemple , mais elle pourrait aussi avoir ToDegreesMinutesSeconds , puisque c'est un autre format pour une paire Lat/Long. Ce même type pourrait alors remplacer ToString avec l'un de ceux pour fournir un" défaut "pour des choses comme le débogage, ou même potentiellement pour des choses comme le rendu de pages web (par exemple, la construction @ dans Razor écrit le ToString() résultat d'une expression non-chaîne au flux de sortie).

object.ToString() convertit un objet en sa représentation string. Si vous souhaitez modifier ce qui est retourné lorsqu'un utilisateur appelle ToString() sur une classe que vous avez créé, vous devez remplacer ToString() dans cette classe.

si vous n'outrepassez pas ToString alors vous obtenez l'implémentation de vos classes de base qui, pour Object est juste le nom de type court de la classe.

si vous voulez une autre mise en œuvre, plus significative ou utile de ToString alors le remplacer.

cela peut être utile lorsque vous utilisez une liste de votre type comme source de données pour un ListBox comme le ToString sera automatiquement affiché.

une autre situation se produit quand vous voulez passer votre type à String.Format qui invoque ToString pour obtenir une représentation de votre type.

bien que je pense que l'information la plus utile a déjà été fournie, je vais ajouter mes deux cents:

• ToString() est destiné à être dépassé. Son implémentation par défaut renvoie le nom du type qui, bien que peut-être utile à certains moments (en particulier quand on travaille avec beaucoup d'objets), ne suffit pas dans la grande majorité des cas.

• rappelez-vous que, pour le débogage, vous pouvez compter sur DebuggerDisplayAttribute . Vous pouvez en lire plus à ce sujet ici .

• en règle générale, sur POCOs, vous pouvez toujours remplacer ToString() . Les POCOs sont une représentation structurée de données, qui peuvent généralement devenir une chaîne.

• Conception ToString pour être une représentation textuelle de votre objet. Peut-être ses principaux champs et données, peut-être une description du nombre d'éléments de la collection, etc.

• toujours essayer d'ajuster cette chaîne dans une seule ligne et n'avoir que des informations essentielles. Si vous avez une classe Person avec nom, adresse, numéro, etc. propriétés, retourner Seulement les données principales (nommer un numéro D'identification).

• veillez à ne pas outrepasser une bonne mise en œuvre de ToString() . Certaines classes framework implémentent déjà ToString() . Passer outre que la mise en œuvre par défaut est une mauvaise chose: attendez-vous à un certain résultat de ToString() et obtenez un autre.

N'ayez pas vraiment peur d'utiliser ToString() . La seule chose que je ferais attention, c'est de rendre des informations sensibles. Autre que cela, le risque est minime. Bien sûr, comme certains l'ont souligné, d'autres classes utiliseront votre ToString chaque fois qu'ils chercheront des informations. Mais bon sang, quand est-ce que retourner le nom de type sera considéré comme mieux que d'obtenir quelques informations réelles?

quelque chose que personne d'autre n'a encore mentionné: en remplaçant ToString() , vous pouvez également envisager de remplacer ToString(string Formatter) de sorte que vous pouvez faire ce qui suit:

 public override ToString() {
   string strOut = string.Format("{0,-20} {1, -20}", m_work, m_personal);
   return strOut;
 }

 public override ToString(string formatter) {
   string strOut = this.ToString();
   switch (formatter.ToLower()) {
     case "w":
       strOut = m_Work;
       break;
     case "p":
       strOut = m_Personal;
       break;
     case "hw":
       strOut = string.Format("mailto:{0}", m_Work);
       break;
   }
   return strOut;
}

qui peut être utile.

un avantage de ToString() est le support d'outils de Resharper: Alt + Ins - > " formater les membres " et il écrit le ToString() pour vous.

dans certains cas, il est plus facile de lire les valeurs des classes personnalisées dans la fenêtre de surveillance du débogueur. Si je sais exactement ce que je veux voir dans la fenêtre de la montre, quand je remplace ToString avec cette information, Alors je le vois.

lors de la définition de structures (effectivement utilisateurs-primitives) je trouve qu'il est de bonne pratique d'avoir des méthodes de correspondance ToString , et Parse et TryParse , en particulier pour la sérialisation XML. Dans ce cas, vous convertirez l'état entier en chaîne, de sorte qu'il puisse être lu plus tard.

sont toutefois des structures plus composées qui seront généralement trop complexes pour pouvoir utiliser ToString et Parse . Leurs méthodes ToString , au lieu de sauvegarder l'état entier, peut être une simple description qui vous aide à identifier leur état, comme un identifiant unique comme un nom ou un ID, ou peut-être une quantité pour une liste.

aussi, comme L'a dit Robbie, la suppression de ToString vous permet d'appeler ToString sur une référence aussi basique que le type object .

vous pouvez utiliser cela quand vous avez un objet avec un sens non intuitif de la représentation de chaîne, comme personne. Donc, si vous avez besoin par exemple d'imprimer cette personne, vous pouvez utiliser cette commande pour préparer son format.

la méthode Object.ToString ne doit être utilisée qu'à des fins de débogage. L'implémentation par défaut montre le nom du type d'objet qui n'est pas très utile. Envisager de remplacer cette méthode pour fournir de meilleures informations pour le diagnostic et de débogage. S'il vous plaît considérer que les infrastructures de journalisation utilisent souvent la méthode ToString aussi bien et donc vous trouverez ces fragments de texte dans vos fichiers de log.

Ne pas retour texte localisé ressources dans la méthode Object.ToString . La raison en est que la méthode ToString doit toujours retourner quelque chose que le développeur peut comprendre. Le développeur peut ne pas parler toutes les langues que l'application supporte.

implémenter l'interface IFormattable lorsque vous voulez retourner un texte localisé convivial. Cette interface définit une surcharge ToString avec les paramètres format et formatProvider . Le formatProvider vous aide à formater le texte d'une manière consciente de la culture.

Voir Aussi: objet.ToString et IFormattable

Simple dépend de la façon dont votre propriété va être utilisé. Si vous avez juste besoin de formater la chaîne d'un temps, puis il ne fait pas beaucoup de sens, primordial.

Cependant, Il semble que vous substituez la méthode ToString pour pas de retour à la normale de la chaîne de données pour votre propriété , mais pour effectuer une mise en forme standard modèle. Puisque vous utilisez string.format avec rembourrage.

parce que vous dites que vous apprenez, l'exercice apparaît aussi frapper sur les principes fondamentaux de la programmation orientée objet se rapportant à l'encapsulation de code et de le ré-utiliser.

la corde.format prenant les arguments que vous avez mis pour le padding assure que la propriété sera formatée de la même manière à chaque fois pour n'importe quel code qui l'appelle. Ainsi, à l'avenir, vous n'avez qu'à modifier dans un seul endroit au lieu de plusieurs.

grande question et aussi quelques grandes réponses!

je trouve utile de surcharger la méthode ToString sur les classes entity car elle permet d'identifier rapidement les problèmes dans testing en particulier quand une assertion échoue la console de test va invoquer la méthode ToString sur l'objet.

mais en accord avec ce qui a été dit avant c'est de donner une représentation humaine lisible de l'objet en question.