C # XML /// Commentaires, d'où vient balise afficher?

StackOverflow https://stackoverflow.com/questions/1845376

  •  12-09-2019
  •  | 
  •  

Question

Je suis actuellement étudiant en programmation, et évidemment ma question est simple, mais je ne l'ai pas été en mesure de trouver la réponse à cette question en ligne. Alors voici:

Dans XML /// commentaires en C #, d'où vient la balise <returns> show, je sais que tout le contenu de la balise <summary> apparaît dans IntelliSense lorsque vous passez votre souris sur votre appel de méthode, mais pas l'étiquette de retour.

D'où vient donc la balise <returns> entrer?

Merci.

Était-ce utile?

La solution

Quand vous voyez la méthode dans la vue >> Explorateur d'objets

Par exemple, vous verrez quelque chose comme ceci: 

private int GetColumnIndex(Microsoft.Office.Interop.Excel.Worksheet worksheet, string columnName, int rowIndex, int startColumnIndex)
    Member of MyAddIn.CommandHandlers.CommandHandler

Summary:
Returns the column index with specified name and in specified row

Parameters:
worksheet: Target worksheet
columnName: Column name to find
rowIndex: Row index in which to search the column
startColumnIndex: Start index of the column

Returns:
The index of column if found, else returns 0

Autres conseils

Si vous générez la documentation de l'API à partir des commentaires, il apparaîtra dans la Valeur de retour section, comme on le voit ici , juste avant le Remarques section.

Lorsque vous choisissez de construire un fichier de documentation XML sur la compilation, tout ce qui est contenu dans les commentaires la documentation XML obtient copié sur dans ce fichier. Des programmes comme Sandcastle peut alors construire la documentation HTML semblable à la MSDN de cela.

Il ne montre pas dans son propre IntelliSense de Visual Studio, pour autant que je sache. Mais ce n'est pas excuse pour ne pas écrire quelque chose :-). Ctrl + Q ReSharper par exemple Finalité montrer.

Les autres sections (essentiellement tout sauf summary) ne figurent pas dans IntelliSense. Elles sont uniquement destinées à figurer dans la documentation générée à partir du XML, à l'aide d'un outil comme Sandcastle .

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top