Inserire descrizione per metodi e proprietà

venerdì 14 settembre 2012 - 18.45
Tag Elenco Tags  C#

andrestu Profilo | Expert

una semplice domanda:

Visual Studio
come si fà ad inserire la descrizione che viene visualizzata a scomparsa quando si ci sposta con il cursore sopra ad un metodo o altro elemento ?


Andrea Restucci - Web Developer

dupperelko Profilo | Junior Member

Ciao,
non capisco cosa vuol dire "con il cursore sopra ad un metodo o altro elemento ?"

Se intendi i fumetti a run time, basta inserire tooltip..

come questo:
http://msdn.microsoft.com/it-it/library/system.windows.forms.visualstyles.visualstyleelement.tooltip.balloon.aspx

ciao

Vinsent Profilo | Senior Member

Penso voglia sfruttare l' intellisense dell' ide....con VB basta scrivere tre apostrofi prima di una procedura o dichiarazione e automaticamente si crea uno schema di base, comprensivo di eventuali parametri, dove inserire tutti i commenti del caso. Si possono implementare molte funzioni ma a me basta lo schema base quindi di più non so...
Per C# mi sembra più complesso ma io conosco solo VB...comunque questi link dovrebbero essere di un qualche aiuto:

http://msdn.microsoft.com/it-it/library/hcw1s69b(v=vs.100).aspx
http://msdn.microsoft.com/it-it/library/s0we08bk(v=vs.100).aspx
http://msdn.microsoft.com/it-it/library/b2s063f7(v=vs.100).aspx
http://msdn.microsoft.com/it-it/library/5ast78ax(v=vs.100).aspx

ciao!

alx_81 Profilo | Guru

>Per C# mi sembra più complesso ma io conosco solo VB...comunque
>questi link dovrebbero essere di un qualche aiuto:
per c#, metodo di esempio:
/// <summary> /// Descrizione metodo /// </summary> /// <param name="param1">Descrizione</param> /// <param name="param2">Descrizione</param> public static void Metodo()...
--
Alessandro Alpi | SQL Server MVP
MCP|MCITP|MCTS|MCT

http://www.alessandroalpi.net
http://blogs.dotnethell.it/suxstellino
http://mvp.microsoft.com/profiles/Alessandro.Alpi

andrestu Profilo | Expert

Grazie per le risposte.
L'esempio di Alex è quello che intendevo, ho sempre usato commenti tramite // oppure /* */ invece in questo modo vedi la descrizione anche tramite intellisense ...


Andrea Restucci - Web Developer

algraps Profilo | Junior Member

ciao a tutti,
scusate se mi intrometto ma volevo suggerire un tool open per poter scrivere commenti dei metodi e dei paramentri in modo automatico.. magari lo conoscete. Il tool e' Gogsthdoc http://submain.com/products/ghostdoc.aspx

andrestu Profilo | Expert

cosa intendi con "automatico" ??? sempre devi scriverli a manina altrimenti che descrizioni sono...

Andrea Restucci - Web Developer

algraps Profilo | Junior Member

Inserisce una descrizione a seconda del nome del metodo e inserisce ai parametri una descrizione sempre a secondo del codice...
Naturalmente se vuoi una descrizione piu' dettagliata devi scrivere tu. Comunque se i metodi e i parametri hanno dei nomi "parlanti", la descrizione del metodo creata utilizzando GhostDoc e' piu' che accettabile.

andrestu Profilo | Expert

scusate riapro la discussione perchè non riesco ad inserire un commento che riguarda i parametri di un delegate Action, facendo un banale esempio:

/// <summary>
/// descrizione generica del mio delegate
/// </summary>
public Action<string, string> MyAction { get; set; }

va bene con la descrizione generica ma non so come commentare i parametri, in questo caso sono 2 parametri di tipo string, il commento di solito utilizzato per i parametri di metodo non funziona.
sull'msdn non ci sono esempi a sufficenza per questo tipo di commenti (Animali!!!)
qualcuno mi può illuminare prima che do fuoco al pc ?






Andrea Restucci - Web Developer
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-2017
Running on Windows Server 2008 R2 Standard, SQL Server 2012 & ASP.NET 3.5