Domande con tag 'documentation'

domande con tag
10
risposte

Come rendere più comprensibile un grande codebase per i nuovi programmatori

Supponiamo che io stia sviluppando un progetto relativamente grande. Ho già documentato tutte le mie classi e funzioni con Doxygen, tuttavia, ho avuto l'idea di inserire una "nota del programmatore" su ciascun file di codice sorgente. L'idea...
posta 01.08.2015 - 00:33
0
risposte

Il mio capo desidera una spiegazione inglese linea per linea del nostro codice

Mi è stato specificamente chiesto di dare una spiegazione riga per riga (o come appropriato - per esempio, immagine per immagine, ecc.) che il mio capo vuole essere in grado di leggere e seguire. Poiché non è un programmatore, non può seguire...
posta 24.10.2011 - 16:09
4
risposte

Qual è l'equivalente del numero di telefono di example.org?

RFC 2606 riserva i nomi di dominio esempio. org , example.net e example.com per lo scopo di essere usato come esempio nella documentazione. Che cosa è un equivalente per un numero di telefono (incluso il prefisso internazionale) che pu...
posta 07.08.2018 - 18:32
13
risposte

Quali sono gli esempi di commenti che ti dicono perché invece di come o cosa? [chiuso]

Prima di tutto, in questa domanda mi piacerebbe stare lontano dalla polemica sul fatto che i commenti sul codice sorgente siano buoni o cattivi. Sto solo cercando di capire più chiaramente cosa intendono le persone quando parlano di commenti che...
posta 09.08.2013 - 08:51
12
risposte

La cronologia dei commit dovrebbe essere utilizzata per trasmettere informazioni critiche agli sviluppatori?

Durante una riunione riguardante il rollback di un SDK di terze parti dall'ultima versione, è stato notato che i nostri sviluppatori erano già contrassegnati nella cronologia dei commit che la versione più recente non doveva essere utilizzata....
posta 29.07.2014 - 15:59
16
risposte

Cosa c'è di sbagliato nei commenti che spiegano codice complesso?

Un sacco di persone sostengono che "i commenti dovrebbero spiegare" perché ", ma non" come "". Altri dicono che "il codice dovrebbe essere auto-documentante" ei commenti dovrebbero essere scarsi. Robert C. Martin afferma che (riformulato secondo...
posta 01.09.2014 - 02:28
17
risposte

I commenti di TODO hanno senso? [chiuso]

Sto lavorando a un progetto abbastanza grande e ho avuto l'incarico di fare alcune traduzioni per questo. C'erano tonnellate di etichette che non sono state tradotte e mentre stavo scavando attraverso il codice ho trovato questo piccolo pezzo di...
posta 11.11.2013 - 10:46
15
risposte

Ho intenzione di lasciare il mio lavoro a causa della nostra piattaforma: come posso lasciare una spiegazione produttiva di questo? [chiuso]

Ho intenzione di abbandonare il mio attuale lavoro perché siamo bloccati nell'utilizzo di Blub , con un framework aziendale Blub e un web server di livello Blub, su hosting condiviso mediocre. I miei colleghi sono cordiali e il mio capo è un pi...
posta 31.03.2012 - 19:34
10
risposte

Esiste troppe funzioni / metodi privati?

Capisco l'importanza di un codice ben documentato. Ma capisco anche l'importanza del codice auto-documentante . Più è facile leggere visivamente una determinata funzione, più velocemente possiamo andare avanti durante la manutenzione del softwa...
posta 14.02.2011 - 00:26
13
risposte

Il codice commentato può essere una documentazione preziosa?

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...
posta 11.03.2013 - 10:36