Aggiungere una descrizione al tooltip di una propria classe

martedì 30 gennaio 2007 - 15.25

Daniele G. Profilo | Newbie

E' una mia curiosità visto che in rete non trovo nulla.
Se io creo una mia classe:

Public class classe

Sub New(param1,param2)

'
'
'
ecc.

in Visual Studio 2005 intelliSense la "riconosce" e quindi, quando faccio una nuova istanza "classe",

Dim classe1 As New Classe(

, mi visualizza un tooltip in cui specifica i nomi dei parametri e che tipo di variabile va immessa. La domanda è: come si fa ad aggiungere una descrizione testuale a questi tooltip, del tipo "Il param1 deve essere bla, il param2 deve essere bla bla", come avviene nelle classi native del framework? Non trovo nulla da nessuna parte, forse mi manca la definizione giusta per quella cosa

alx_81 Profilo | Guru

>Dim classe1 As New Classe(
>
>, mi visualizza un tooltip in cui specifica i nomi dei parametri
>e che tipo di variabile va immessa. La domanda è: come si fa
>ad aggiungere una descrizione testuale a questi tooltip, del
>tipo "Il param1 deve essere bla, il param2 deve essere bla bla",
>come avviene nelle classi native del framework? Non trovo nulla
>da nessuna parte, forse mi manca la definizione giusta per quella
>cosa
>
Devi premere 3 volte il carattere ' e VS 2005 ti fa apparire la parte summary:
''' <summary>
'''
''' </summary>
''' <param name="sender"></param>
''' <param name="e"></param>
''' <remarks></remarks>

aggiungi qui le info che ti servono..
Ciao!
Alx81 =)

http://blogs.dotnethell.it/suxstellino

totti240282 Profilo | Guru

Questa mi mancava
C'è solo un capitano !!!!!!

alx_81 Profilo | Guru

>Questa mi mancava

Attenzione.. solo visual studio 2005 lo ha nativamente.. (per VB, C# lo ha con triplo "/" fin da VS 2003)..
Per VS 2003, c'è una plugin scaricabile, il VBCommenter..
qui..

http://www.gotdotnet.com/workspaces/releases/viewuploads.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd

ciao!

Alx81 =)

http://blogs.dotnethell.it/suxstellino

Daniele G. Profilo | Newbie

Thx, ora provo

totti240282 Profilo | Guru

non mi funziona ho fatto cosi...

''' <summary>
''' prova descrizione
''' </summary>
''' <param name="porta"></param>
''' <remarks></remarks>
Public Function connetti(ByVal porta As String) As String
......
...............
.....................
C'è solo un capitano !!!!!!

alx_81 Profilo | Guru

che VS hai?
Alx81 =)

http://blogs.dotnethell.it/suxstellino

totti240282 Profilo | Guru

2005 professional
C'è solo un capitano !!!!!!

alx_81 Profilo | Guru

>2005 professional

Stessa versione:


908x306 51Kb



456x323 38Kb



492x328 40Kb


dove richiami la tua funzione?
sei in un progetto diverso? è una reference?
sei in una classe diversa?
fammi sapere che faccio una prova..

Alx81 =)

http://blogs.dotnethell.it/suxstellino

totti240282 Profilo | Guru

>dove richiami la tua funzione?
la richaimo da un'altro progetto importando prima la dll creata.
>sei in un progetto diverso? è una reference?
si/si


C'è solo un capitano !!!!!!

alx_81 Profilo | Guru

>>dove richiami la tua funzione?
>la richaimo da un'altro progetto importando prima la dll creata.

se hai cambiato il root namespace non si vede di default..
come mi ha detto un collega veramente expert in queste cose, di default quando carichi progetti VB esterni e quando cambi il root namespace non riesci a vedere i tooltip..
Il motivo è che il progetto referenziato non trova il file xml con lo stesso nome della dll del progetto (scioccata di visual studio).
Quindi devi andare ad aprire il file del progetto con notepad, impostando il corretto riferimento all'xml alla voce "DocumentationFile".
Il nome corretto lo trovi nelle rispettive cartelle di debug e release.. vedrai che c'è un file xml il cui nome non corrisponde a quello della dll..
ciao!

>
>C'è solo un capitano !!!!!!

Alx81 =)

http://blogs.dotnethell.it/suxstellino

totti240282 Profilo | Guru

quindi tu dici che nella cartella bin/release.... ci deve essere anche un file di documentazione xml ??? io nelle opzioni ho messo di non crearlo.
C'è solo un capitano !!!!!!

alx_81 Profilo | Guru

>quindi tu dici che nella cartella bin/release.... ci deve essere
>anche un file di documentazione xml ??? io nelle opzioni ho messo
>di non crearlo.
Eh allora non vedi davvero quel tooltip
>C'è solo un capitano !!!!!!

Alx81 =)

http://blogs.dotnethell.it/suxstellino

totti240282 Profilo | Guru

ok allora rimetterò il segno di spunta su genera documentazione XML ecc....

grazie ti farò sapere...
C'è solo un capitano !!!!!!
Partecipa anche tu! Registrati!
Hai bisogno di aiuto ?
Perchè non ti registri subito?

Dopo esserti registrato potrai chiedere
aiuto sul nostro Forum oppure aiutare gli altri

Consulta le Stanze disponibili.

Registrati ora !
Copyright © dotNetHell.it 2002-2024
Running on Windows Server 2008 R2 Standard, SQL Server 2012 & ASP.NET 3.5