Comentários XML não exibindo no IntelliSense
-
20-09-2019 - |
Pergunta
Estou tentando fazer com que os comentários do VB.NET XML funcionem Intellisense, e talvez não funcione do jeito que eu acho.
''' <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>
Isso deve, quando você estiver digitando em uma função, exibir o "Get ou define o código do paciente", então abaixo disso, ele deve exibir uma lista de itens com "validação" como cabeçalho?
Alt Text http://www.codejames.com/errored.jpg
Talvez eu esteja fazendo errado, mas não parece estar funcionando corretamente.
Solução
Você não está fazendo isso incorretamente, simplesmente não é suportado. Embora as marcas HTML possam aparecer na saída de algumas ferramentas, o Intellisense não é um deles.
O IntelliSense é uma exibição textual no Visual Studio 2008 e não suportamos exibição de muitas / a maioria das marcas, pois elas devem aparecer em uma exibição no estilo HTML. Em vez disso, tendemos a retirar as tags de marcação que não são suportadas e exibem o texto resultante.
Outras dicas
Você pode "fingir" (sem os números) ao redor do <description>
conteúdo com o <para>
TAG - Isso será exibido pelo menos no IntelliSense bem espaçado, mas sem o delimitador da lista apropriado (bala, número).
<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>
Se você não se importa muito com a saída gerada, basta adicionar sua bala em cada linha:
<item><description><para>* Field Required</para></description></item>
Veja também <list>
Documentação XML
Atualizar
Desde que publiquei isso, o vs2012 11.0.60610.01 Atualização 3 parece ter adicionado suporte de formatação, para que você não precise mais do <para>
embalagem interna ou adicionar suas próprias balas.