Le mystérieux Tag « d'utilisation » dans le commentaire XML Documentation Visual Studio Mots

Question

J'utilise souvent des documents XML pour documenter mes classes, méthodes et propriétés, mais jetez un oeil à cette méthode de Microsoft:

Utilisation? Quel genre de sorcellerie est ce? Comment émule-t-on cette sorcellerie?

Il n'y a rien de tel dans le code source, j'ai vérifié (.Net 4.5). Il n'y a pas non plus de balise xmldoc, elle n'est pas supposée exister et pourtant elle apparaît dans l'info-bulle.

Je l'ai remarqué il y a un certain temps mais je n'ai pas eu le temps d'enquêter, alors maintenant j'ai eu et j'ai perdu au moins une heure à essayer de le comprendre en vain.

C'est une bonne chose car elle apparaît dans les infobulles. Nous avons le tag <example> mais ce n'est pas ça, c'est une bête complètement différente.

Answer 1

Tout ce que je peux trouver est l'élément <code>, mais il ne fournit pas une sortie soignée comme un à l'image.

On dirait qu'il est codé en dur pour Task méthodes statiques, quelque part à l'intérieur du Visual Studio: reference code et github ne contiennent pas de tels commentaires xml, et je ne trouve pas d'autres méthodes avec une telle Usage chose, même les async les.

Peut-être que cela fait partie du support de Visual Studio pour la syntaxe async/await, notifiant au développeur de ne pas oublier d'attendre la tâche créée.

Mise à jour: Je pense qu'il s'agit d'un comportement Visual Studio. Considérez ce code:

public static Task<int> TestMethod1() 
{ 
    return Task.FromResult(9); 
} 

public static async Task<int> TestMethod2() 
{ 
    return await Task.FromResult(9); 
} 

deux de ces méthodes permettront à la section Usage pop-up, sans aucun commentaire xml. Donc, c'est un rappel pour le développeur de ne pas oublier d'attendre le Task s.