Commentare un codice

[kicco]

 
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?
 

[kicco]

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"
 

[vuott]

Fenomenologia soggettiva della tecnica descrittiva

[Gianluigi]

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?
 

Qui puoi avere un aiuto:

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

 

[kicco]

 

[vuott]

Ne avevo fatto un accenno alcuni anni fa, ma non trovo la discussione qui. 

[kicco]

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!
 

[Gianluigi]

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 

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!
 

Appunto 

[kicco]

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.
 

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

[Gianluigi]

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.
 

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.

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

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

 

[vuott]

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 

[vuott]

...ovviamente puoi usare i tag HTML.
Prova ad esempio questo:   

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

[Gianluigi]

Per me non suona la campana, strano perché non mi sento niente bene 

Se uso il browser funziona, nella IDE no

 

P.S. L'idea è carina e sarebbe anche utile poter registrare un audio da allegare come guida

[vuott]

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 ? 

P.S. L'idea è carina e sarebbe anche utile poter registrare un audio da allegare come guida

Infatti.   
E' possibile richiamare ovviamente file audio appositamente inseriti nella cartella "Dati" del progetto.

[vuott]

...oppure se preferite questo:   

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