Ingegneria software comments

4

Il "Ottiene o imposta .." è necessario nella documentazione XML delle proprietà?

Sto cercando una raccomandazione di una best practice per i commenti XML in C #. Quando si crea una proprietà, sembra che la documentazione XML prevista abbia la forma seguente: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. /// </summary> public int …

19 c# .net programming-practices comments

6

È buona norma commentare con il numero di problema?

Ho visto molti numeri di problema dai commenti del codice jQuery . (In realtà, c'erano 69 numeri di emissione nel codice jQuery.) Penso che sarebbe una buona pratica, ma non ho mai visto linee guida. Se è una buona pratica, quali sono le linee guida per questa pratica?

18 comments issue-tracking

9

Perché la maggior parte dei linguaggi di programmazione non annidano i commenti a blocchi?

Alcuni lo fanno, ma non quelli popolari per quanto ne so. C'è qualcosa di brutto nel annidare i commenti? Ho intenzione di far annidare i commenti a blocchi nella (piccola) lingua su cui sto lavorando, ma vorrei sapere se questa è una cattiva idea.

18 language-agnostic syntax comments

10

“//…” commenti alla fine del blocco di codice dopo} - buoni o cattivi? [chiuso]

Chiuso . Questa domanda è basata sull'opinione . Al momento non accetta risposte. Vuoi migliorare questa domanda? Aggiorna la domanda in modo che possa essere risolta con fatti e citazioni modificando questo post . Chiuso 4 anni fa . Ho visto spesso usare tali commenti: function foo() { ... } …

18 source-code comments

8

I commenti in linea "modificati da" sono la norma nei negozi che utilizzano il controllo di revisione?

Il senior dev nel nostro negozio insiste sul fatto che ogni volta che il codice viene modificato, il programmatore responsabile dovrebbe aggiungere un commento in linea affermando ciò che ha fatto. Questi commenti di solito sembrano// YYYY-MM-DD <User ID> Added this IF block per bug 1234. Usiamo TFS per il …

17 coding-standards comments

6

È necessario scrivere un commento javadoc per OGNI parametro nella firma di un metodo?

Uno degli sviluppatori del mio team ritiene che sia necessario scrivere un commento javadoc per OGNI parametro nella firma di un metodo. Non penso che ciò sia necessario, e in effetti penso che possa persino essere dannoso. Prima di tutto, penso che i nomi dei parametri dovrebbero essere descrittivi e …

17 java documentation source-code comments maintainability

5

È corretto inserire un collegamento ai siti di domande e risposte nei commenti di un programma?

In un po 'di codebase puoi vedere commenti che affermano cose come: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Quindi ho alcune domande, ma sono tutte correlate. È corretto inserire un collegamento a domande SO nei commenti di un programma: // We're now mapping from the …

16 comments

7

Utilizzo di NotImplementedException

È considerata una cattiva pratica lanciare NotImplementedExceptionper il codice che non hai ancora scritto? Forse i commenti TODO sarebbero considerati più sicuri?

15 .net comments coding exceptions

16

Una lingua che non consente i commenti produrrebbe un codice più leggibile? [chiuso]

È difficile dire cosa viene chiesto qui. Questa domanda è ambigua, vaga, incompleta, eccessivamente ampia o retorica e non può essere ragionevolmente risolta nella sua forma attuale. Per assistenza per chiarire questa domanda in modo che possa essere riaperta, visitare il centro assistenza . Chiuso 8 anni fa . Solo …

15 comments

9

Qual è un buon modo per commentare le clausole if-else-? [chiuso]

Allo stato attuale, questa domanda non è adatta al nostro formato di domande e risposte. Ci aspettiamo che le risposte siano supportate da fatti, riferimenti o competenze, ma questa domanda probabilmente solleciterà dibattiti, argomenti, sondaggi o discussioni estese. Se ritieni che questa domanda possa essere migliorata e possibilmente riaperta, visita …

15 comments

4

Esistono giustificazioni per lasciare gli indicatori di conflitto nel codice archiviato?

Prendi in considerazione i marker di conflitto. vale a dire: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD Nel caso particolare che mi ha motivato a pubblicare questa domanda, il membro del team responsabile aveva appena completato una fusione a monte della nostra filiale e in alcuni …

14 version-control comments coding-style

6

Annota il codice sorgente con diagrammi come commenti

Scrivo molto codice (principalmente c ++ e javascript) che tocca la geometria computazionale e la grafica e quel tipo di argomenti, quindi ho scoperto che i diagrammi visivi sono stati una parte indispensabile del processo di risoluzione dei problemi. Ho determinato proprio ora che "oh, non sarebbe fantastico se potessi …

14 productivity code-reviews comments workflows image-manipulation

2

Qual è l'approccio migliore per i commenti di codice inline?

Stiamo eseguendo il refactoring di una base di codice legacy di 20 anni e sto discutendo con il mio collega sul formato dei commenti nel codice (plsql, java). Non esiste un formato predefinito per i commenti, ma nella maggior parte dei casi le persone fanno qualcosa di simile nel commento: …

13 java c# programming-practices code-quality comments

7

Cosa devo includere nell'intestazione della documentazione della mia classe

Sto cercando un formato di documentazione informativo per le classi Entity, Business Logic e Data Access. Ho trovato i seguenti due formati da qui Formato 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// …

13 c# documentation comments

1

Presentazione di variabili locali aggiuntive come sostituzione dei commenti

È bello usare variabili locali aggiuntive, tecnicamente superflue, per descrivere cosa sta succedendo? Per esempio: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Quando si tratta di sovraccarico tecnico, mi aspetto che il compilatore ottimizzi questa linea aggiuntiva. Ma è considerato un eccesso di …

12 coding-style comments

Domande taggate «comments»