Domande con tag 'comments'

domande con tag
5
risposte

Un commento al metodo deve includere sia un sommario che una descrizione di ritorno quando sono spesso così simili?

Sono un sostenitore del codice correttamente documentato e Sono ben consapevole dei possibili svantaggi di esso . Questo è al di fuori dello scopo di questa domanda. Mi piace seguire la regola di aggiungere commenti XML per ogni membro pub...
posta 09.11.2011 - 14:33
3
risposte

I tipi di docblock sono ridondanti quando si utilizza una digitazione rigorosa

Ho una base di codice privata abbastanza grande che si è evoluta da circa dieci anni. Non sto usando phpDocumentor, ma dal momento che l'uso delle sezioni docblock è diventato piuttosto lo standard nei progetti open source ho adottato anche la s...
posta 02.02.2018 - 10:25
17
risposte

Perché un'azienda dovrebbe sviluppare un'atmosfera che scoraggi i commenti del codice? [duplicare]

Mi è stato insegnato in università a scrivere commenti per i nostri programmi. Mentre scrivo commenti, mi sento come se avessi un'organizzazione migliore e comprendessi meglio i programmi. Tuttavia, sono in una società in cui la maggior par...
posta 30.12.2013 - 14:07
5
risposte

È generalmente utile includere i problemi JIRA nei commenti di codice?

Di tanto in tanto, lascio commenti come # We only need to use the following for V4 of the computation. # See APIPROJ-14 for details. o # We only need to use the following for V4 of the computation. # See https://theboringcompany.atlassian...
posta 14.02.2018 - 18:27
4
risposte

Quale sarebbe un buon modo per richiedere commenti?

Nel progetto / team che sto lavorando la frequenza dei commenti è un po 'bassa. Una ragione potrebbe essere che non è chiaro agli sviluppatori di vecchia data quali righe nel codice veramente hanno bisogno di un commento (ogni parte del proget...
posta 12.09.2012 - 08:58
1
risposta

Formato commento intestazione

Mi rendo conto che il formato di "commento di intestazione" varia da programmatore a programmatore, ma quale sarebbe un esempio di un commento di intestazione "buono"?     
posta 31.03.2011 - 00:29
7
risposte

Commentando le espressioni regolari

Esistono pratiche comuni per commentare le espressioni regolari: commenti in linea che fanno riferimento a parti diverse di RegEx o commenti generali per tutte le espressioni?     
posta 05.12.2012 - 13:00
6
risposte

Devo aggiungere note MSDN o collegamenti Stack Overflow al codice sorgente? [duplicare]

Sto creando un host PowerShell / C # e voglio aggiungere il seguente commento // This method cannot be called multiple times on a given pipeline. The state of the // pipeline must be NotStarted when Invoke is called. When this method is c...
posta 11.02.2012 - 16:33
3
risposte

Uso intenzionalmente scorretto delle funzionalità del linguaggio, in particolare "ref" in C #, come suggerimento per i colleghi

Recentemente ho trovato un pezzo di codice simile a questo (all'incirca C #): public bool ValidateStuff(ref ArrayList listOfErrors, Stuff thingsToValidate) { if (!thingsToValidate.isValid() ) { errors.add("New error!"); } }...
posta 05.09.2014 - 22:16
6
risposte

Commenti divisionali / sezionali, buoni o cattivi?

Conosco la tendenza generale contro i commenti che spiegano come funziona qualcosa, e come sia una buona idea usarli solo per spiegare perché stai facendo quello che stai facendo, ma come usare i commenti come mezzo per dividere il codice? Su...
posta 10.11.2010 - 16:14