Ingegneria software comments

11

Commenti sul controllo della versione - passato o presente [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 . Per i commenti sul controllo della versione cosa fanno / raccomandano …

12 comments source-code

3

I suggerimenti di tipo docblock sono ridondanti quando si utilizza la digitazione rigorosa

Ho una base di codice privata abbastanza grande che si è evoluta per circa dieci anni. Non sto usando phpDocumentor ma dato che l'uso delle sezioni docblock è diventato piuttosto lo standard nei progetti open source, ho adottato la scrittura di docblock per tutti i metodi pubblici nel mio repository. …

12 php comments

2

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

Sto lavorando a un progetto "spaghetti-code" e, mentre correggo i bug e implemento nuove funzionalità, faccio anche un po 'di refactoring per rendere il codice testabile. Il codice è spesso così strettamente accoppiato o complicato che la correzione di un piccolo bug comporterebbe la riscrittura di molte classi. Così ho …

11 refactoring comments

8

Commentare espressioni regolari

Esistono pratiche comuni per commentare le espressioni regolari: commenti incorporati che fanno riferimento a parti diverse di RegEx o commenti generali per tutte le espressioni?

11 documentation coding-style comments

7

Altri commenti sono migliori negli ambienti con fatturato elevato?

Stavo parlando con un collega oggi. 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 cooperativi che vanno e vengono abbastanza regolarmente (ogni 8-12 mesi). Ha detto …

11 coding-style team comments

1

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 a cosa serviva quella classe o dovrei aggiungerlo sotto il commento?

11 java code-quality api comments

6

I commenti sono considerati una forma di documentazione?

Quando scrivo piccoli script per me stesso, impilo il mio codice in alto con commenti (a volte commento più di quanto codice). Molte persone con cui parlo affermano che dovrei documentare questi script, anche se sono personali, in modo che se mai li vendessi, sarei pronto. Ma i commenti non …

11 documentation comments

3

I commenti XML sono necessari documentazione?

Ero un fan del richiedere commenti XML per la documentazione. Da allora ho cambiato idea per due motivi principali: Come il buon codice, i metodi dovrebbero essere autoesplicativi. In pratica, la maggior parte dei commenti XML sono rumori inutili che non forniscono alcun valore aggiuntivo. Molte volte usiamo semplicemente GhostDoc …

10 .net programming-practices development-process documentation comments

5

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

Sono un sostenitore del codice adeguatamente documentato e sono ben consapevole dei possibili aspetti negativi di esso . Questo è al di fuori dell'ambito di questa domanda. Mi piace seguire la regola di aggiungere commenti XML per ogni membro pubblico, considerando quanto mi piace IntelliSense in Visual Studio. Esiste tuttavia …

10 documentation comments intellisense

7

Scrivere documentazione per metodi ben compresi come uguali a Java

È una buona pratica scrivere commenti per metodi ampiamente conosciuti come uguaglianza, confronto, ecc.? Considera il codice seguente. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code for equals } La mia azienda si …

10 java comments

1

Che cosa significa "TILT" in un commento?

Sto leggendo Clean Code di Robert C. Martin e la frase TILTappare inspiegabilmente in alcuni esempi di codice. Esempio (è in Java, a proposito): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case ErrorCode.UNEXPECTED_ARGUMENT: return "Unexpected argument"; case ErrorCode.MISSING_ARGUMENT: …

9 java clean-code comments conventions

3

Come fare riferimento a specifiche aree di codice nella documentazione?

Sto per lasciare un progetto e prima di andare 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 posti nella mia documentazione in cui vorrei dire: "Avviso sulla linea XYZ …

9 documentation comments

2

Modo DRY per scrivere Javadoc su metodi di sovraccarico

Voglio scrivere Javadoc in modo SECCO. Ma il documento dell'oracolo su Javadoc dice di scrivere di nuovo la stessa cosa nel commento del metodo di sovraccarico. Non posso evitare la ripetizione?

9 documentation comments dry javadocs

8

Perché tutti scrivono commenti da fare in maiuscolo? [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 …

9 comments

7

Stili di documentazione per commenti / in-code

Questa potrebbe essere una domanda stupida, ma è stata nella mia testa per un po '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 descrizione, anche se ce n'è solo uno. Questo porta a molte …

9 documentation comments coding-style

Domande taggate «comments»