Domande con tag 'comments'

domande con tag
2
risposte

Qual è il sostantivo per il risultato di un'iterazione?

Sto commentando qualche codice in questo momento, e sto cercando una parola che significhi che la cosa sia stata ripetuta. Iterator è un oggetto che esegue una iterazione , ma qual è l'oggetto che l'iteratore sta iterando; il risultato di una...
posta 15.02.2016 - 21:10
3
risposte

Come si indica una variabile in un commento?

Diciamo che ho la seguente funzione in Python: def foo(one, two): return one + two E voglio documentarlo con "adds one to two" . Tuttavia, questo è confuso, perché potrei solo dire che la funzione aggiunge letteralmente il numero...
posta 07.05.2018 - 22:27
1
risposta

Alternativa per il codice commentato che verrà utilizzato in seguito

Ho dovuto implementare un modulo che, una volta completato, il client ha improvvisamente chiesto che per un po 'non fosse necessario visualizzarlo, così mi è stato detto di commentarlo (visto che probabilmente lo useremo in seguito), cosa che ho...
posta 29.08.2018 - 04:12
5
risposte

Esegui su frasi nella scrittura tecnica

Questa è solo una domanda a cui pensare. Quando scrivi documentazione tecnica e commenti di programmazione, ti ritrovi mai a scrivere frasi run-on per essere più preciso? È meglio impacchettare più informazioni tecniche in una frase piutto...
posta 22.06.2011 - 22:22
2
risposte

Dove inserire commenti, dichiarazione di classe o costruttore?

Per una determinata classe, dove dovrebbero andare i commenti sullo scopo della classe? /// <summary> /// <----------------- describe the class here (1)? /// </summary> public class Message { ... //class members here...
posta 20.02.2014 - 12:39
4
risposte

E 'normale aver bisogno di tempo per capire il codice che ho scritto di recente [chiuso]

Di recente intendo alcune settimane fa. Sto cercando di continuare un progetto che ho lasciato 2 settimane fa e ho bisogno di tempo per capire alcune funzioni che ho scritto (non copiate da qualche parte) e mi ci vuole tempo. Normalmente non ne...
posta 27.05.2014 - 00:45
3
risposte

Dove devo inserire commenti nel mio "codice di autocertificazione"?

Attualmente sto sviluppando una web-app da sola e ho deciso di usare nomi descrittivi di variabili e metodi (a volte a scapito della brevità) per minimizzare i commenti. Il piano era di codificare ogni metodo usando questa strategia, quindi comm...
posta 23.05.2011 - 19:47
4
risposte

Le azioni / i metodi dovrebbero essere coniugati nei commenti?

Ad esempio, quale delle seguenti è corretta? // Return hello -- or -- // Returns hello function greeting() { return "Hello"; } Personalmente mai li coniughi, ma mi chiedo quanto possa sembrare giusto o sbagliato un madrelingua in...
posta 28.10.2015 - 08:13
3
risposte

C'è un modo per commentare un file sorgente usando un file separato?

Uso una libreria ampia e complessa che include codice R e C ++, disponibile online tramite un repository di subversion. Cercando di capire come funziona ho preso un mucchio di note nel codice sorgente stesso, sotto forma di commenti. Anni dopo,...
posta 18.08.2016 - 17:38
2
risposte

Aggiunte relative all'infrastruttura nei commenti di commit

Per rispondere a questa domanda, concordiamo su questa definizione di "messaggio di buona comunicazione" da qui : Your comment should be brief and to the point, describing what was changed and possibly why. e accetta che fare riferiment...
posta 25.11.2013 - 11:23