Newsgroup: it.comp.lang.visual-basic
Titolo: [.NET] Documentazione funzioni e procedure.

Ciao a tutti,
usando l'IDE VS .NET, scrivendo in VB e richiamando metodi di classi, ad 
esempio di Textbox, l'intellisense mostra il prototipo o la dichiarazione 
del metodo stesso ed inoltre un commento ad esso, tipo "Imposta o 
restituisce [...]". Ora vorrei chiedervi se sia possibile includere tali 
"commenti" anche ai metodi che scrivo io in modo che siano visibili con 
l'intellisense quando seleziono il metodo stesso.
Esempio:
Classe mia_classe
public sub mio_metodo( value as string)
quando richiamo tale metodo mi piacerebbe vedere nel tooltip di intellisense 
una cosa tipo
public sub mio_metodo(value as string)
Il parametro "value" contiene il testo che il metodo userà per ...
In Java la cosa è fattibile dichiarando dei codici particolari nei commenti 
prima del metodo stesso, ma in VB .NET ?
Grazie e buona domenica :)
Luca.

 Luca.
Andrea

 l'intellisense quando seleziono il metodo stesso.
Su 
VB.NET
 (VS 2003) attualmente non è possibile inserire i commenti "in
linea" durante la programmazione lo sarà nella prossima release.
Per poter gestire i commenti (come il C# già permette) in 
VB.NET
 e poi
trasformarli in documentazione devi installare due moduli aggiuntivi
(entrambi gratuiti)
A questo link trovi tutto quello che ti serve:
http://vb-doc.sourceforge.net/
-- 
questo articolo e` stato inviato via web dal servizio gratuito 
http://www.newsland.it/news
 segnala gli abusi ad 
ab...@newsland.it

Grazie ad Andrea e Luciano per le risposte.
E' interessante il tool indicatomi da Luciano; la mia esigenza però non è 
tanto quella di avere documentazione globale delle varie classi in un xml 
esterno, seppure l'utilità è notevole.
Cercherò di esporre meglio ciò che vorrei o vi chiedo di darmi qualche 
dettaglio in più se sono io a non vedere la soluzione.
Definisco una nuova classe che ha un metodo, my_method ().
Istanzio un oggetto da questa classe e ne richiamo il metodo. Quando digito 
il "punto" a destra del nome dell'oggetto, l'ambiente mi rende disponibile 
una sorta di documentazione in linea (rettangolo giallo) nel quale viene 
riportata la dichiarazione del metodo e niente altro. Io vorrei aggiungere 
del testo che possa apparire insieme alla dichiarazione, come avviene per 
metodi di oggetti istanze di classi native del framework.
Forse, come scriveva Luciano, è proprio questo non ancora fattibile con VB 
.NET in VS 2003 ?
Luca.

Basta che ti scarichi l'add-in VBCommenter e segui quanto indicato qui
http://www.microsoft.com/indonesia/msdn/VBGeneratingDocs.asp
Nel tuo caso il tag e' <remarks></remarks>, la parte di NDoc e' opzionale 
(nel tuo caso) e ricorda che il file xml deve stare nella stessa dir 
dell'assembly che descrive.
HTH
-- 
Corrado Cavalli [Microsoft .NET MVP-MCP]
UGIdotNET - 
http://www.ugidotnet.org
Weblog: 
http://blogs.ugidotnet.org/corrado/

 HTH
Corrado, grazie per la tua risposta.
Alla URL che mi hai indicato c'e' un link a VBCommenter che però non 
funziona, comunque ho reperito  il tool (versione 1.2.5) che funziona come 
illustrato ovvero crea commenti e nella fase di built in crea il file xml.
Non riesco però a fare in modo che qualche campo (remarks o summary o 
overloads) sia visibile nel riquadro di intellisense. Ho proceduto cosi:
Progetto,contiene una classe che eredita da System[...].Form; aggiungo una 
classe, Class1.
Creo un metodo, public sub metodo_mio() e prima di tale dichiarazione pongo 
i commenti (iniziando con '''): compilo le sezioni <remarks>, 
<summary>,<overloads>,<history>.
Salvo, compilo.
Dalla classe del mio form, dichiaro ed istanzio un oggetto Class1. Quando 
richiamo il "metodo_mio" non mi viene mostrato niente che non sia la sola 
dichiarazione del prototipo: "Public Sub metodo_mio()"
:(
Dove sbaglio?
Il file XML viene compilato sia nella main dir dell'applicazione sia nella 
cartella BIN. Le opzioni di VBCommenter sono impostate come illustrato 
nell'articolo sul sito Microsoft. Il file XML è corretto e contiene i dati 
che ho inserito.
Luca.

Se ben ricordo il tutto funziona solo se fai riferimento alla dll compilata, 
non funge se la dll è in design mode.



Si, sarà cosi, domani verificherò :) Grazie comunque!
Luca.