Question

Je suis en train d'obtenir les commentaires XML VB.NET pour travailler avec IntelliSense , et peut-être ne fonctionne pas la façon dont je pense qu'il fait.

    ''' <summary>
    ''' Gets or sets the Patient Code.
    ''' <list type="bullet">
    ''' <listheader><description>Validation:</description></listheader>
    ''' <item><description>Field Required</description></item>
    ''' <item><description>Field Max Length: 25</description></item>
    ''' </list>
    ''' </summary>
    ''' <value>The region reference key.</value>

Cela devrait, lorsque vous tapez dans une fonction, afficher le « Get ou définit le Code du patient », puis en dessous, il devrait afficher une liste d'éléments avec puces « Validation: » comme l'en-tête

texte alt http://www.codejames.com/errored.jpg

Peut-être que je fais mal, mais il ne semble pas fonctionner correctement.

Était-ce utile?

La solution

Vous ne faites pas cela correctement, il est tout simplement pas pris en charge. Alors que les balises HTML peuvent apparaître dans la sortie de certains outils, IntelliSense n'est pas un d'entre eux.

IntelliSense est un affichage textuel dans Visual Studio 2008 et nous ne soutenons pas l'affichage de nombreux / la plupart des marges bénéficiaires qu'ils doivent apparaître dans un écran de style HTML. Au lieu de cela, nous avons tendance à dépouiller les balises qui ne sont pas pris en charge et afficher le texte résultant.

Autres conseils

Vous pouvez « faux » (sans les chiffres) en entourant le contenu de <description> avec la balise <para> -. Ce sera au moins apparaître dans IntelliSense bien espacés, mais sans le séparateur de liste appropriée (puce, numéro)

<summary>
Gets or sets the Patient Code.
<list type="bullet">
<listheader><description>Validation:</description></listheader>
<item><description>Field Required</description></item>
<item><description>Field Max Length: 25</description></item>
</list>
</summary>
<value>The region reference key.</value>

Si vous ne vous souciez pas grand-chose à propos de la sortie générée, ajoutez simplement votre balle dans chaque ligne:

<item><description><para>* Field Required</para></description></item>

Voir aussi <list> XML Documentation

Mise à jour

Depuis l'affichage de cette, VS2012 11.0.60610.01 Update 3 semble avoir ajouté le formatage de soutien, afin de ne plus besoin de l'emballage interne <para> ou en ajoutant vos propres balles.

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