Domande con tag 'documentation'

domande con tag
4
risposte

Come documentare un progetto già sviluppato?

Vorrei sapere quali opzioni sono disponibili per documentare un progetto che è già stato sviluppato, poiché gli sviluppatori che hanno lavorato non hanno scritto nemmeno una singola pagina di documentazione. Il progetto non ha altri dettagli...
posta 13.05.2013 - 09:43
6
risposte

Mi fa diventare un cattivo programmatore se non apprezzo la metodologia Agile? [chiuso]

Mi piacciono le piccole iterazioni. Mi piacciono i test unitari. Mi piace la revisione del codice. Quello che non mi piace è l'avvio con poca o nessuna documentazione. Sono solo in questo? Ho semplicemente un fraintendimento del processo? Ogn...
posta 11.05.2011 - 16:27
4
risposte

Perché i commenti / documentazione di una funzione JavaScript dovrebbero includere così tanto? [duplicare]

Stavo studiando le pratiche di commento appropriate per JavaScript e la risposta con una buona spinta (+100) cita i commenti di tipo JSDoc. JSDoc promuove commenti come questo: /** * Represents a book. * @constructor * @param {string} tit...
posta 19.09.2015 - 01:23
2
risposte

Documentazione di un linguaggio di programmazione: Manuale di riferimento

Stiamo esaminando la revisione della documentazione attraverso la nostra linea di prodotti. Parte di ciò include manuali di riferimento per un linguaggio di programmazione utilizzato come parte del sistema. Quando scrivi un manuale di rif...
posta 14.05.2012 - 05:48
5
risposte

Documentazione del codice: pubblico vs non pubblico?

Sono uno di quegli sviluppatori che ha la mentalità che il codice scritto dovrebbe essere auto-esplicativo e leggere come un libro. TUTTAVIA, quando si sviluppa codice di libreria per altre persone da utilizzare, cerco di mettere tutta la doc...
posta 01.06.2011 - 01:44
1
risposta

Precisione implicita delle funzioni in virgola mobile

Durante la revisione della implementazione di una funzione per calcolare la normale CDF di distribuzione di un altro programmatore, ho eseguito un suggerimento per sostituire l'intera implementazione con le funzioni built-in di Python o util...
posta 08.08.2014 - 21:04
5
risposte

Come documentare le regole aziendali

Mi chiedo quale sarebbe il metodo formale e il più comunemente praticato per documentare le regole aziendali? Inoltre, come documentare le specifiche dell'interfaccia utente degli artefatti di sviluppo (ad esempio, documentare i campi dei moduli...
posta 28.06.2011 - 20:54
4
risposte

Esiste uno standard per documentare l'architettura di alto livello di un programma?

Sono uno sviluppatore dilettante e tutti i miei programmi fino ad ora erano abbastanza semplici da essere documentati all'interno del codice. Durante la lettura del codice era chiaro cosa stavo facendo una tale azione (il mio test standard era g...
posta 25.04.2017 - 12:26
3
risposte

Scrittura di commenti java doc per casi di test unitari

A mio parere, i casi di test unitario servono come documentazione per il codice. La mia azienda vuole che scriva dettagliati commenti di documenti java in cima ai casi di test unitario. È necessario farlo? Scrivi commenti del genere?     
posta 21.09.2011 - 06:17
5
risposte

È una buona idea scrivere le specifiche dei requisiti in base alle storie?

Al momento stiamo utilizzando metodi agili nel mio progetto corrente e abbiamo un mucchio di storie come queste: Come assistente, desidero pagare un rimborso a un cliente in modo che possano farlo ottenere dei soldi quando lo richiedono...
posta 14.03.2012 - 01:50