Domande con tag 'comments'

domande con tag
3
risposte

I commenti XML sono documenti necessari?

Ero un fan di richiedere commenti XML per la documentazione. Da allora ho cambiato idea per due motivi principali: Like good code, methods should be self-explanatory. In practice, most XML comments are useless noise that provide no addit...
posta 22.10.2012 - 16:16
7
risposte

Stili di documentazione per commenti / codici

Questa potrebbe essere una domanda stupida, ma è stata per un po 'nella mia testa e non riesco a trovare una risposta decente da nessun'altra parte. Ho un insegnante che dice che dovremmo elencare esplicitamente ogni parametro con una descriz...
posta 06.12.2010 - 19:15
3
risposte

Come fare riferimento a specifiche aree di codice nella documentazione?

Sto per lasciare un progetto, e prima che me ne vada il mio capo mi ha chiesto di documentare il codice (non ho documentato molto bene). Non è un grosso problema, il progetto non è terribilmente complesso. Ma sto trovando dei posti nella mia doc...
posta 28.12.2012 - 17:45
2
risposte

Modo ASCIUTTO per scrivere Javadoc sui metodi di sovraccarico

Voglio scrivere Javadoc in modo ASCIUTTO. Ma il documento dell'oracolo su Javadoc dice di scrivere di nuovo la stessa cosa nel metodo di overload commento. Non posso evitare la ripetizione?     
posta 13.01.2012 - 03:25
11
risposte

Cosa devo inserire nei commenti durante il commit del controllo del codice sorgente?

Sono uno sviluppatore solitario e gestisco un server SVN per il controllo del codice sorgente. Finora, non ho seguito nulla di specifico mentre ho commesso i miei cambiamenti. Stavo solo rivedendo i miei precedenti commit e non riuscivo a dar...
posta 01.12.2011 - 09:22
6
risposte

! - open - Perché così tanti sviluppatori fanno questo nel loro HTML? !- /vicino --

<body> <!-- wrapper --> <div id="wrapper"> <!-- title --> <div id="title"><img src="title.png" alt="" /></div> <!-- form wrapper --> <div id="form_wrapper"> <!--...
posta 28.10.2010 - 00:06
3
risposte

Perché alcune librerie open source mancano di commenti?

Non so se questo accada alla maggior parte delle librerie di Opensource, ma molti di quelli che conosco e usano (ad esempio OpenSSL, Webkit, ...) mancano tutti i commenti o contengono pochissimi commenti. Per non parlare dei loro pochissimi d...
posta 01.07.2013 - 07:00
3
risposte

La lettura di javadoc è preferibile alla lettura del codice sorgente per familiarizzare con una libreria?

Ho appena trovato quanto segue in un manuale di laboratorio all'università: You do need to study the interfaces of the classes by generating the javadoc for them so you know what operations are provided (feel free to look at the code, but...
posta 04.02.2015 - 14:28
4
risposte

La sintassi per disabilitare il codice dovrebbe differire da quella dei normali commenti?

Per diversi motivi durante lo sviluppo, a volte commento il codice. Dato che sono caotico e talvolta di fretta, alcuni di questi lo rendono al controllo del codice sorgente. Uso anche commenti per chiarire blocchi di codice. Ad esempio:...
posta 22.08.2011 - 13:06
8
risposte

Lo stile di commento influisce sul modo in cui i lettori interpretano il codice?

Questa domanda mi ha ossessionato negli ultimi 2 mesi. Qualche tempo fa un amico che è un grande programmatore mi ha dato alcuni codici di esempio, e per la prima volta ho notato uno stile unico di organizzazione dei commenti. Si è sforzato d...
posta 20.02.2012 - 20:30