Far apparire un commento a una risorsa nella finestrina guida
E' possibile far apparire un nostro commento, riferito a una risorsa, nell'apposita finestrina guida durante la scrittura dell'identificatore di tale risorsa nell'editor del codice.
Per ottenere questo risultato è necessario rispettate le seguenti regole:
1) il Commento deve accompagnare la "dichiarazione" di un identificatore;
2) il Commento può solo accompagnare l'identificatore di Costanti, Variabili Globali, Variabili Locali, Sub-routine (Eventi, Funzioni e Procedure);
3) l'identificatore deve essere composto da almeno 4 caratteri, affinché possa apparire la finestrina della guida;
4) il Commento deve essere posto sulla destra (ossia dopo) della dichiarazione;
5) il Commento deve essere preceduto immediatamente alla sua sinistra tassativamente da almeno 2 singoli apostrofi (') (dunque NON il carattere delle doppie-virgolette):
Private Const VALORE As Integer = 10000 ''Questo è un commento
6) il Commento può essere posto anche al di sopra della dichiarazione, ma tra i due apostrofi e il primo carattere testuale del commento deve esserci uno spazio:
'' Questo è un commento Private Const VALORE As Integer = 10000
Indice
Uso dei TAG del protocollo HTML nei Commenti
Si possono usare alcuni TAG del protocollo HTML, per caratterizzare (anche con oggetti multimediali) un Commento, quando esso apparirà nella finestrina guida durante la scrittura - nel codice - dell'identificatore della risorsa già commentata in dichiarazione.
Pertanto, ogni qual volta nel codice si scriverà il nome dell'identificatore della risorsa, commentata come descritto nel paragrafo precedente, si vedrà nella finestra guida il commento con le caratteristiche testuali impostate mediante i TAG del protocollo HTML.
Esempi pratici
Modificare l'aspetto del font
Private Const VALORE As Integer = 10000 ''<B><I><U><FONT Size=5>Questo è un commento
Attribuire un colore al commento
Private Const VALORE As Integer = 10000 ''<FONT Color=red>Questo è un commento
Usare un file immagine
Private Const VALORE As Integer = 10000 ''<IMG Src=/percorso/del/file/immagine>Questo è un commento
dal web:
Private Const VALORE As Integer = 10000 <IMG Src=https://www.gambas-it.org/wiki/resources/assets/gambas-wiki-logo.png>Questo è un commento
Eseguire un file audio/Midi/video/immagine
Private Const VALORE As Integer = 10000 ''<A Href=/percorso/del/file/mediale>Questo è un commento
Per eseguire il file mediale, si dovrà ovviamente cliccare sul testo del commento.
Per terminare l'esecuzione, sarà sufficiente premere sulla tastiera il tasto "Back Space" (ossia quello che cancella i caratteri a sinistra del cursore).
