Domande con tag 'comments'

domande con tag
7
risposte

Sono più commenti meglio negli ambienti ad alto turnover?

Oggi stavo parlando con un collega. Lavoriamo sul codice per due diversi progetti. Nel mio caso, sono l'unica persona che lavora sul mio codice; nel suo caso, più persone lavorano sulla stessa base di codice, compresi gli studenti in co-op che v...
posta 01.06.2012 - 03:03
1
risposta

Qual è il modo migliore per commentare una classe deprecata in Java?

Vorrei sapere il modo migliore per aggiungere un commento per identificare una classe deprecata in Java. Devo rimuovere il commento precedente aggiunto all'inizio della classe che aiuta un altro programmatore a sapere per cosa è stata quella cla...
posta 05.09.2011 - 16:42
2
risposte

Il codice di diffusione con i commenti di refactoring è una buona idea?

Sto lavorando a un progetto "spaghetti-code", e mentre correggo bug e implementando nuove funzionalità, eseguo anche alcuni refactoring per rendere il codice testabile all'unità. Il codice è spesso così strettamente accoppiato o complicato ch...
posta 05.11.2013 - 09:00
5
risposte

Annota il codice sorgente con diagrammi come commenti

Scrivo molto codice (principalmente c ++ e javascript) che tocca la geometria e la grafica computazionale e questi tipi di argomenti, quindi ho scoperto che i diagrammi visivi sono stati una parte indispensabile del processo di risoluzione dei p...
posta 19.11.2012 - 00:31
11
risposte

Commenti del controllo della versione - tempo passato o presente [chiuso]

Per commenti sul controllo della versione che cosa fanno / raccomandano gli altri utenti - passato o presente? cioè. Modificato x per essere y. o Modifica x per essere y.
posta 08.03.2011 - 18:41
6
risposte

I commenti sono considerati una forma di documentazione?

Quando scrivo piccoli script per me stesso, impilo il mio codice in alto con i commenti (a volte commento più del codice I). Molte persone con cui parlo dicono che dovrei documentare questi script, anche se sono personali, così che se mai li ven...
posta 14.05.2012 - 02:06
4
risposte

Perché i commenti / documentazione di una funzione JavaScript dovrebbero includere così tanto? [duplicare]

Stavo studiando le pratiche di commento appropriate per JavaScript e la risposta con una buona spinta (+100) cita i commenti di tipo JSDoc. JSDoc promuove commenti come questo: /** * Represents a book. * @constructor * @param {string} tit...
posta 19.09.2015 - 01:23
7
risposte

Documentazione di scrittura per metodi ben compresi come gli uguali in Java

È una buona pratica scrivere commenti per metodi ampiamente conosciuti come equals, compareTo etc? Considera il codice seguente. /** * This method compares the equality of the current object with the object of same type */ @Override p...
posta 07.09.2011 - 14:14
8
risposte

Perché tutti scrivono commenti da fare in maiuscolo? [chiuso]

Sto facendo lo stesso. Quando c'è qualcosa di "da fare" nel mio codice, scrivo //TODO ... . Ma sono curioso di sapere quando è iniziato e se c'è un motivo per scrivere "cose da fare" in tutte le lettere maiuscole?     
posta 24.12.2011 - 00:12
5
risposte

Come devo gestire l'eccezione che * dovrebbe * non essere mai lanciata? [duplicare]

Qual è il modo migliore per gestire gli errori che non dovrebbero mai accadere? Il mio attuale modo di fare ciò è di lanciare un'eccezione se la "cosa che non dovrebbe accadere" è , in questo modo: /* * Restoring from a saved state. Thi...
posta 29.04.2014 - 15:36