Far apparire un commento a una risorsa nella finestrina guida

E' possibile far apparire un nostro commento, riferito a una risorsa, all'interno dell'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 l'apostrofo di destra e il primo carattere testuale del commento deve esserci almeno uno spazio (qui evidenziato in giallo):

'' Questo è un commento
Private Const VALORE As Integer = 10000

Come si è compreso, il presente argomento tratta dei commenti alle dichiarazioni formali delle risorse e dei relativi identificatori, di cui al precedente punto 2), e pertanto non ha alcun impatto concreto con le funzionalità del codice del programma. Quanto descritto in questo argomento, potrà essere verificato cominciando a scrivere all'interno codice del programma il nome dell'identificatore della risorsa, commentata con il doppio apostrofo e nel rispetto dei punti sopra elencati: nella finestra guida che, come al solito appare, sarà mostrato anche il nostro commento con le eventuali caratteristiche ad esso apportate mediante i TAG Html.

Uso dei TAG del protocollo HTML nei Commenti

Si possono usare alcuni TAG del protocollo HTML ^{[nota 1]}, 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.

Alcuni 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

'' <FONT Color=red>Questo è un commento
Private Const VALORE As Integer = 10000

Creare una tabella contenente il commento

Private Const VALORE As Integer = 10000 ''<TABLE border=1 width=300 height=200 bgcolor=yellow><tr><td><FONT Size=5>Questo è un commento

Usare un file immagine

Private Const VALORE As Integer = 10000 ''<IMG Src=/percorso/del/file/immagine>Questo è un commento</img>

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</img>

Eseguire file mediali

Eseguire un file audio/Midi/video/immagine

'' <A Href=/percorso/del/file/mediale>Cliccami per eseguire il file !
Private Const VALORE As Integer = 10000

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).
Analogamente per l'esecuzione di un video dal web:

Private Const VALORE As Integer = 10000 <A Href=https://cdn.pixabay.com/video/2016/01/14/1917-152081339_large.mp4>Questo è un commento</a>

Usare anche i TAG del protocollo HTML specifici per la gestione dei file mediali

Per i file audio e Midi:

Private Const VALORE As Integer = 10000 ''<AUDIO controls><Source src=file:///percorso/del/file/audio/o/Midi  type=audio/TIPO /></audio>

Il tipo sarà così impostato:
Per i file WAV => wav
Per i file OGG => ogg
Per i file MP3 => mpeg
Per i file Midi => midi

Per i file video:

Private Const VALORE As Integer = 10000 ''<VIDEO width=640 height=480 controls><Source src=file:///percorso/del/file/video /></video>

analogamente per vedere un video dal web:

Private Const VALORE As Integer = 10000 ''<VIDEO width=640 height=480 controls><Source src=https&058;//cdn.pixabay.com/video/2016/01/14/1917-152081339_large.mp4 /></video>

Mostrare un sito web

Private Const VALORE As Integer = 10000 ''<A Href=https://www.gambas-it.org/smf>Questo è un commento</a>

Anche in questo caso, per far caricare e mostrare la pagina del sito web indicata, bisognerà cliccare sul testo del commento.

Suddividere la scrittura del commento nel codice in una o più righe a capo

Se un commento all'interno del codice risulta essere eccessivamente lungo, e si preferisce suddividerlo in una o più righe a capo, ogni riga a capo:
- deve essere posta esclusivamente al di sopra della dichiarazione della risorsa di Gambas;
- deve essere preceduta da 2 apostrofi e da uno spazio;
- non deve avere TAG Html spezzati. Ogni TAG Html deve iniziare (<) e terminare (>) nella medesima riga del commento. Insomma, nessun TAG Html deve iniziare in una riga del commento e chiudersi nella riga successiva sottostante del commento.

Esempio di commento suddiviso nel codice in tre righe:

Public Sub Main()

'' <A Href=https://sgi2.isprambiente.it/arcgis/rest/services/raster/igm25k_lazio_wgs/ImageServer?f=jsapi>
'' <B><FONT Color=red>Cliccami !</font></b></a>
'' <BR>Poi ingrandisci la finestrina e aumenta lo zoom.
  Dim Topografica_Lazio_IGM_1_25000 As Integer

---

Note

[1] Vedere questa pagina della wiki: Elenco delle istruzioni HTML compatibili