Gambas-it

Gambas3 => Programmazione => Topic aperto da: kicco - 16 Marzo 2021, 12:50:20

Titolo: Commentare un codice
Inserito da: kicco - 16 Marzo 2021, 12:50:20
 :ciao:
Volevo migliorare i commenti posti nel codice, volevo capire se esistono delle regole generali condivise.
Qualcuno sa darmi qualche dritta su un testo che affronti il tema?
 :ciao:
Titolo: Re:Commentare un codice
Inserito da: kicco - 16 Marzo 2021, 17:17:39
Speravo in qualche indicazione tipo:
"Sul commento al codice dalla preistoria ad oggi"
"Compendio sulle metodologie comparate di commento dei codici informatici secondo la scuola informatica occidentale"
"Sistemi trascendentali di descrizione del codice"

 :P
Titolo: Re:Commentare un codice
Inserito da: vuott - 16 Marzo 2021, 17:33:24
Fenomenologia soggettiva della tecnica descrittiva

Titolo: Re:Commentare un codice
Inserito da: Gianluigi - 16 Marzo 2021, 19:15:59
:ciao:
Volevo migliorare i commenti posti nel codice, volevo capire se esistono delle regole generali condivise.
Qualcuno sa darmi qualche dritta su un testo che affronti il tema?
 :ciao:

Qui puoi avere un aiuto:

http://gambaswiki.org/edit/doc/helpcomments

 :ciao:
Titolo: Re:Commentare un codice
Inserito da: kicco - 16 Marzo 2021, 20:22:47
 :ok:
Titolo: Re:Commentare un codice
Inserito da: vuott - 16 Marzo 2021, 20:53:46
Ne avevo fatto un accenno alcuni anni fa, ma non trovo la discussione qui.  :-\
Titolo: Re:Commentare un codice
Inserito da: kicco - 17 Marzo 2021, 09:44:00
Sul web non ho trovato molto, solo alcune regole generale che, per l'amor del cielo, vanno bene, ma pensavo a qualcosa di più specifico.
Cerco ancora.
Ho visto che qua sul forum, molte volte non riesco a trovare i riferimenti a degli argomenti che so abbiamo trattato, anche scritti da me, perchè sono "annidati" in altri con titoli del post che non c'entra niente.
Partiamo con un  tema e ne sviluppiamo un altro!
 :-\
Abbiamo un'opportunità di miglioramento!
 :ciao:
Titolo: Re:Commentare un codice
Inserito da: Gianluigi - 17 Marzo 2021, 10:33:14
Sul web non ho trovato molto, solo alcune regole generale che, per l'amor del cielo, vanno bene, ma pensavo a qualcosa di più specifico.
Cerco ancora.
Se vuoi sapere qualcosa di specifico occorre aprire una nuova discussione con la specifica domanda  :-\
Citazione
Ho visto che qua sul forum, molte volte non riesco a trovare i riferimenti a degli argomenti che so abbiamo trattato, anche scritti da me, perchè sono "annidati" in altri con titoli del post che non c'entra niente.
Partiamo con un  tema e ne sviluppiamo un altro!
 :-\
Abbiamo un'opportunità di miglioramento!
 :ciao:

Appunto  :-X
Titolo: Re:Commentare un codice
Inserito da: kicco - 17 Marzo 2021, 10:53:17
Quando scrivo "di più specifico" intendo dire, non di puntuale  su un tipo di commento, ma qualcosa che non sia solo una serie di asserti generici.
 :ciao:

PS: mi fanno un po' male le orecchie...  :P
Titolo: Re:Commentare un codice
Inserito da: Gianluigi - 17 Marzo 2021, 15:18:48
Quando scrivo "di più specifico" intendo dire, non di puntuale  su un tipo di commento, ma qualcosa che non sia solo una serie di asserti generici.
 :ciao:

La pagina che ti ho linkato indica appunto come va scritto il commento, se vuoi che un domani ti aiuti a ricordare.
Per esempio se hai una classe così:

Codice: [Seleziona]
' Gambas class file

''' Attraverso la proprietà Action questa classe provvede alla gestione
''' dei pulsanti Undo e Redo posizionati sulle diverse finestre.<br>
''' Il codice di gestione va posto nelle classi che ereditano da questa.<br>
''' Per il funzionamento, vedere le sottoclassi.<br>

'' Ripristina le azioni annullate (una per volta)
Public Sub Redo()

End

'' Annulla le azioni precedenti (una per volta)
Public Sub Undo()

End

Vedi dalle immagini allegate il successivo funzionamento.

Citazione
PS: mi fanno un po' male le orecchie...  :P

E questo cosa c'entra? Quello che scrivi nel commento esula dagli orientamenti sessuali  :-\

 :P :ciao:
Titolo: Re:Commentare un codice
Inserito da: vuott - 17 Marzo 2021, 16:38:25
Vedi dalle immagini allegate il successivo funzionamento.
Va infatti sottolineato che l'effetto si avrà nel successivo uso nel codice delle risorse commentate con quegli speciali marcatori.



Co cosa c'entra? Quello che scrivi nel commento esula dagli orientamenti sessuali  :-\

(https://www.fattistrani.it/images/globali/2019-04-14/1555264099un0.gif)
Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 04:09:42
...ovviamente puoi usare i tag HTML.
Prova ad esempio questo:   ;D

Codice: [Seleziona]
'' <audio controls="controls" > <source src="https://www.videomaker.com/sites/videomaker.com/files/downloads/free-sound-effects/Free_%2BBellDoor_1005_27_2.wav" /></audio>
Private commento_audio As Integer




Titolo: Re:Commentare un codice
Inserito da: Gianluigi - 18 Marzo 2021, 11:49:44
Per me non suona la campana, strano perché non mi sento niente bene  :-\

Se uso il browser funziona, nella IDE no

 :ciao:

P.S. L'idea è carina e sarebbe anche utile poter registrare un audio da allegare come guida
Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 12:07:54
Per me non suona la campana, strano perché non mi sento niente bene  :-\
...dici che se io avessi inserito l'indirizzo web di un file contenente l'audio di una campana suonata "a morto", nell'IDE l'avresti sentita ?  :-X



P.S. L'idea è carina e sarebbe anche utile poter registrare un audio da allegare come guida
Infatti.   :ok:
E' possibile richiamare ovviamente file audio appositamente inseriti nella cartella "Dati" del progetto.
Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 12:59:04
...oppure se preferite questo:   :D

Codice: [Seleziona]
'' <video autoplay="true" type="video/webm" src="https://ak.picdn.net/shutterstock/videos/9393401/preview/stock-footage-beautiful-sexy-blonde-business-woman-wearing-skinny-short-dress-jewelry-sunglasses-in-luxury-hotel.webm" controls />
Private abcde As Integer


Titolo: Re:Commentare un codice
Inserito da: Gianluigi - 18 Marzo 2021, 13:05:11
Il video funziona, perché l'audio no?

 :ciao:
Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 13:34:41
Il video funziona, perché l'audio no?
Perché il video è privo di audio.
Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 13:38:54
Oppure mostrare un video da youtube:   ;D

(sono costretto a mostrare il codice su immagine, poiché altrimenti la pagina del forum mi restituisce un avviso)
Titolo: Re:Commentare un codice
Inserito da: Gianluigi - 18 Marzo 2021, 13:45:41
Oppure mostrare un video da youtube:   ;D

(sono costretto a mostrare il codice su immagine, poiché altrimenti la pagina del forum mi restituisce un avviso)

Quando succede questo possiamo allegare un file di testo compresso oppure un progetto, l'immagine non permette il copia/incolla.

 :ciao:
Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 13:51:24
Quando succede questo possiamo allegare un file di testo compresso oppure un progetto, l'immagine non permette il copia/incolla.
Sì, hai ragione.
E' più utile ed opportuno inserire un file di testo.
Provvedo qui stesso.
Titolo: Re:Commentare un codice
Inserito da: kicco - 18 Marzo 2021, 13:56:31
...oppure se preferite questo:   :D

Codice: [Seleziona]
'' <video type="video/webm" src="https://ak.picdn.net/shutterstock/videos/9393401/preview/stock-footage-beautiful-sexy-blonde-business-woman-wearing-skinny-short-dress-jewelry-sunglasses-in-luxury-hotel.webm" controls />
Private abcde As Integer
Non ho capito come usarli però!
Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 14:03:05
Non ho capito come usarli però!

Incolla quelle righe in un progetto e... comincia a scrivere in una routine le prime tre lettere di quella variabile globale indicata nel mio esempio.....   ;D

Esempio:
Codice: [Seleziona]
'' <video type="video/webm" src="https://ak.picdn.net/shutterstock/videos/9393401/preview/stock-footage-beautiful-sexy-blonde-business-woman-wearing-skinny-short-dress-jewelry-sunglasses-in-luxury-hotel.webm" controls />
Private abcde As Integer

Public Sub Main()

' Cominci a scrivere le prime 3 lettere della variabile globale "abcde":
  abc.....

End
Titolo: Re:Commentare un codice
Inserito da: kicco - 18 Marzo 2021, 14:18:56
 :)
Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 14:27:26
e se poi volete onorare San Midi (https://it.wikipedia.org/wiki/Musical_Instrument_Digital_Interface):

Codice: [Seleziona]
'' Ascolta il file Midi.<BR>
'' <AUDIO controls> <source src="https://bitmidi.com/uploads/22626.mid" type="audio/midi" />
Private abcde As Integer

 sanmidi

Sancte Midi, miserere mei !
Titolo: Re:Commentare un codice
Inserito da: kicco - 18 Marzo 2021, 15:59:31
Ho avuto un po' di calma per guardare quello che mi avete indicato, cioè quello che avete usato per travolgermi!!!
È molto interessante e credo che li userò, magari senza barocchismi ( :nonono: vuott) come video e musica...
 :P
Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 16:49:39
... magari senza barocchismi ...

(https://media.giphy.com/media/xUA7aNY6q98YEr87a8/giphy.gif)



... magari senza barocchismi ( :nonono: vuott) come video e musica...
...ma Gianluigi ti ha già fatto capire che può essere interessante e utile inserire video-tutorial !   :violent:


Titolo: Re:Commentare un codice
Inserito da: vuott - 18 Marzo 2021, 17:58:48
...puoi anche inserire ovviamente immagini:

Codice: [Seleziona]
'' Questa è un'immagine dell'antica città romana di <FONT Color="red">Saepinum</font>:<P>
'' <img src="https://live.staticflickr.com/3290/2989255474_61e8d9ac73_b.jpg" width="320">