Domande con tag 'documentation'

domande con tag
6
risposte

Come posso documentare il mio codice per una revisione temporale minima? [chiuso]

Desidero documentare il mio codice in modo tale che sia necessario leggere e sfogliare il codice almeno qualche mese dopo. So che esistono diversi tipi di documentazione (nel codice sorgente e all'esterno, nei diagrammi di sequenza e così via...
posta 08.03.2018 - 07:23
1
risposta

Perché la documentazione su alcune lingue dice "equivalente a" anziché "è"?

Perché la documentazione in alcune lingue dice "equivalente a" anziché "è"? Ad esempio, i documenti Python dicono itertools.chain(*iterables) ... Equivalent to: def chain(*iterables): # chain('ABC', 'DEF') --> A B C D...
posta 15.01.2016 - 05:14
6
risposte

I test unitari sono realmente usati come documentazione?

Non riesco a contare il numero di volte in cui ho letto le dichiarazioni in vena di 'unit test sono una fonte molto importante di documentazione del codice sotto test'. Non nego che siano vere. Ma personalmente non mi sono mai trovato a usarl...
posta 28.06.2012 - 09:32
12
risposte

Cosa rende buona la documentazione? [duplicare]

Ho bisogno di scrivere documentazione per diversi progetti su cui ho lavorato. Mi stavo chiedendo cosa, secondo la vostra esperienza, renda la documentazione utile e completa. Quale parte dovrei includere, quanto dovrei approfondire nella mia...
posta 07.04.2011 - 18:06
5
risposte

In quale grammatica dovrei scrivere le mie specifiche?

Attualmente stiamo scrivendo specifiche funzionali e tecniche in un formato a due colonne; frase riassuntiva e dettaglio tecnico. I dettagli si riferiscono spesso a un'appendice con diagrammi, disegni di layout ecc. Tuttavia, sto lottando con...
posta 18.02.2011 - 15:50
4
risposte

Come documentare la struttura di alto livello di un programma Java?

Sfondo: I miei collaboratori e io stiamo scrivendo un articolo per una rivista accademica. Nel corso della nostra ricerca, abbiamo scritto un programma di simulazione in Java. Vogliamo rendere il programma di simulazione liberamente disponibil...
posta 20.03.2014 - 19:31
4
risposte

Documentare la logica matematica nel codice

A volte, anche se non spesso, devo includere la logica matematica nel mio codice. I concetti usati sono per lo più molto semplici, ma il codice risultante non è - molte variabili con uno scopo non chiaro, e alcune operazioni con intenzioni non c...
posta 27.06.2013 - 13:53
6
risposte

Il vecchio programmatore è scomparso. In procinto di assumere un altro programmatore. Come approccio a questo? [chiuso]

Dopo aver trascorso più di un anno a lavorare su un progetto di rete sociale per me utilizzando WordPress e BuddyPress , il mio programmatore è scomparso, anche se è stato pagato ogni settimana, per l'intero periodo. Sì, non è morto perché ho...
posta 11.10.2013 - 08:15
1
risposta

Quando i sistemi diventano sempre più grandi, come fai a mantenere una comprensione globale del tuo sistema? [duplicare]

Oggi mi sono reso conto penosamente che per alcune decisioni è necessaria una buona conoscenza generale del sistema. Altrimenti, il rischio è troppo alto perché la tua ipotesi si rivelasse sbagliata. Immagina di essere uno sviluppatore di u...
posta 04.09.2014 - 00:25
7
risposte

I wiki sono davvero appropriati per archiviare i documenti per lo sviluppo del software? [chiuso]

Tutti sanno che lo sviluppo di software ben documentato porta al successo. Tuttavia, di solito significa che non solo il testo normale ma anche il contenuto binario saranno coinvolti nel documento, come un diagramma UML. E ho sentito molte perso...
posta 01.05.2011 - 13:32