Domande taggate «comments»

Molte persone affermano che "i commenti dovrebbero spiegare" perché ", ma non" come "". Altri affermano che "il codice dovrebbe essere auto-documentante" e che i commenti dovrebbero essere scarsi. Robert C. Martin afferma che (riformulato alle mie stesse parole) spesso "i commenti sono scuse per il codice scritto male". La …

236 programming-practices  documentation  comments 

Uno dei membri del mio team evita costantemente di fare commenti nel suo codice. Il suo codice non è auto-documentante e altri programmatori hanno difficoltà a comprendere il suo codice. Gli ho chiesto più volte di commentare il suo codice, tuttavia egli fornisce solo scuse o affermazioni che lo farà …

184 teamwork  team  comments 

Ho lavorato in negozi che producono software critici per la vita e mi sono occupato delle regole di commento che avevano lo scopo di mantenere il codice leggibile e potenzialmente salvare vite. Nella mia esperienza, però, il requisito diventa un compito mortale per essere escluso da una lista di controllo …

142 coding-standards  comments  standards  naming-standards  standardization 

Un mio collega crede che qualsiasi uso di commenti in codice (cioè, non metodo javadoc o commenti di classe) sia un odore di codice . Cosa ne pensi?

100 comments  anti-patterns 

sviluppatore junior qui. Attualmente sto lavorando da solo su un'applicazione web per un grande cliente della mia azienda. Ho iniziato il mese scorso. Il cliente desidera almeno il 25% dei commenti in ciascuno dei suoi progetti software. Ho controllato il codice delle precedenti domande ed ecco le mie osservazioni: ogni …

96 project-management  comments  client-relations  hierarchy 

Sto lavorando a un progetto abbastanza grande e ho il compito di fare alcune traduzioni per questo. C'erano tonnellate di etichette che non sono state tradotte e mentre cercavo il codice ho trovato questo piccolo pezzo di codice //TODO translations Questo mi ha fatto pensare al senso di questi commenti …

86 documentation  comments 

Sto discutendo con i miei nuovi colleghi in merito ai commenti. Entrambi amiamo il codice pulito e sto perfettamente bene con il fatto che i commenti al codice in linea dovrebbero essere evitati e che i nomi di classe e metodi dovrebbero essere usati per esprimere ciò che fanno. Tuttavia, …

83 comments  clean-code 

Ho scritto il seguente codice: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } C'è una linea commentata qui. Ma penso che renda il codice più chiaro, rendendo …

83 documentation  comments 

Prima di tutto, in questa domanda vorrei stare lontano dalla polemica sul fatto che commentare il codice sorgente sia positivo o negativo. Sto solo cercando di capire più chiaramente cosa intendono le persone quando parlano di commenti che ti dicono PERCHÉ, COSA o COME. Spesso vediamo linee guida come "I …

78 documentation  comments 

So che Subversion (quello che stiamo usando al lavoro) può essere configurato per richiedere commenti sugli commit, tuttavia non sono in grado di accenderlo semplicemente. So che la mia ragione per commentare i miei commit è perché è utile, se non altro come un jogger di memoria, capire rapidamente il …

78 version-control  comments 

Mi è stato insegnato dal mio capo (ho appena finito la scuola e voleva qualcuno con una piccola esperienza di programmazione, quindi mi ha scelto di addestrarmi su ciò in cui quella società è specializzata) e ha iniziato a lavorare con le applicazioni ASP.NET MVC , alcuni HTML e CSS …

72 comments 

Cosa significano generalmente le persone ogni volta che vedi XXXin un commento. Occasionalmente, vedrò un commento come questo: # XXX - This widget really should frobulate the whatsit Certo, posso dire cosa significa il commento, ma cosa significa generalmente XXX? Sta dicendo "Questo è un trucco" o forse "Forse dovremmo …

72 comments  coding-standards 

Mi sono appena trovato a scrivere il seguente commento in un codice (arcaico di Visual Basic 6.0) che stavo scrivendo: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Non sono sicuro del motivo per cui inconsciamente uso "noi" nei miei …

63 comments  coding-standards 

sfondo Sto lavorando in un team che sta cercando di implementare distribuzioni a zero-downtime. Stiamo programmando di utilizzare una strategia di distribuzione blu / verde per raggiungere questo obiettivo. Una delle cose che sto realizzando nel fare la ricerca è quanto sia complicato apportare modifiche al database. Una semplice operazione …

51 continuous-integration  deployment  comments  continuous-delivery 

Qualcuno una volta ha detto che dovremmo anteporre a tutti i nostri metodi i /// <summary>blocchi di commento (C #) ma non ha spiegato il perché. Ho iniziato a usarli e ho scoperto che mi infastidivano un po ', quindi ho smesso di usarli ad eccezione delle librerie e dei …

49 c#  comments