Domande con tag 'comments'

domande con tag
3
risposte

Nello spirito di coerenza, è accettabile commentare tutto allo stesso modo? [chiuso]

La coerenza è qualcosa che apprezzo (ad un livello perfezionista OCD per essere onesto). Posso vivere senza scrivere nessun commento e concentrarmi sulla produzione di codice buono, rifatto, leggibile - o, se devo commentare, preferirei decide...
posta 19.09.2015 - 03:18
4
risposte

Decifrare codice estraneo [duplicato]

Qual è la migliore strategia per capire il codice di qualcun altro per un progetto di medie dimensioni, se il codice non è ben documentato e non aderisce a molti standard di codifica?     
posta 27.06.2011 - 22:22
1
risposta

Devo documentare le sequenze di chiamata previste quando l'ordine delle chiamate è importante?

Nei linguaggi dinamici e debolmente tipizzati , spesso mi trovo con strutture come il seguente pseudocodice: class Stateful: # [ various datamembers / attributes / properties / fields / etc. ] define constructor(arguments):...
posta 22.10.2015 - 03:23
2
risposte

Come sistematizzare i tag nel codice? [chiuso]

Esistono diversi tag quasi standard utilizzati nei commenti: FIXME , TODO , BUGBUG . Quali altri tag usi e per cosa? Esistono standard per il loro utilizzo, ovvero il formato (che integra con la data e le iniziali), le procedure di revi...
posta 29.01.2011 - 23:21
1
risposta

Devo aggiungere commenti XML nei modelli DTO o nei modelli di entità

Ho 2 modelli, DTO e modelli di database (entità) che si associano al database. Solitamente inserisco i commenti XML sopra le proprietà per descrivere a cosa servono. class MyEntity { /// <summary> /// Some summary /// <...
posta 07.06.2018 - 10:19
0
risposte

Commentando le applicazioni MVC [duplicate]

Recentemente mi sono reso conto che il mio posto di lavoro non commenta le loro applicazioni MVC ASP.NET. Con 'non documenta', intendo che c'è probabilmente 1 riga di commento per modello / vista / controller. Nessuno scopo del file, data di c...
posta 03.02.2014 - 03:55
2
risposte

Commenting Code AS3 - Non essendo un'API

Come dovrei commentare un metodo? Quali sono le migliori pratiche sul codice di commento? Esempio: /* Checks if a color is allowed in a given point * of the bitmapdata of the current floor * @param value - color to be checked * @return b...
posta 14.04.2012 - 21:05
3
risposte

È una buona pratica commentare con il nome del proprietario? [duplicare]

Ecco diversi scenari che possono commentare con il nome del proprietario: risoluzione dei bug, ovvero // fixed bug 123 by xxx, solution is ... ... fixme / tag todo, ovvero // TODO: .... by xxx. hack, cioè // HACK! ... by...
posta 21.12.2011 - 04:28
4
risposte

Enfatizza alcuni commenti - ma non sporca il codice

Ho problemi a strutturare i miei commenti al momento. Ho sezioni principali del codice che, durante lo scorrimento del documento, voglio essere in grado di vederle. Esempi: This is a normal comment: int money = 100; //start...
posta 15.03.2011 - 20:52
1
risposta

L'uso di commenti non standard su riga singola è soddisfacente in C? [chiuso]

Ho notato che Visual C ++ 2010 (il mio ambiente corrente) e XCode consentono entrambi commenti a riga singola non standard nei miei programmi C. Dal momento che queste sono entrambe le piattaforme di destinazione, presumo che sia giusto usarlo?...
posta 20.01.2014 - 06:51