Domande con tag 'documentation'

domande con tag
3
risposte

Come faccio a documentare necessariamente strutture di codice complesse?

Se ho un pezzo di codice che è matematicamente o strutturalmente abbastanza complesso e irriducibilmente così, come farei per documentare questo pezzo di codice? In particolare, come posso garantire che qualcuno che non possiede le abilità matem...
posta 14.05.2012 - 04:21
1
risposta

Come documentare correttamente un algoritmo con dati di esempio?

Mi chiedo che cosa dovrebbe contenere una documentazione dell'algoritmo? Impossibile individuare una linea guida corretta da seguire. Ho in mente di includere riepilogo dell'algoritmo descrizione dell'algoritmo diagrammi di flusso pseu...
posta 18.07.2011 - 09:40
1
risposta

Come mantenere aggiornati gli esempi di codice in javadoc

Sto lavorando su una piccola libreria che fornisce implementazioni di metriche di base e ben note. Principalmente per la mia educazione. Quindi lo sviluppo accade ogni volta che ho un po 'di tempo libero. Per questo motivo ho automatizzato la...
posta 10.08.2015 - 17:30
2
risposte

Come documentare una specifica di formato di file [chiuso]

Per un progetto, ho bisogno di lavorare con vari tipi di file da alcuni vecchi giochi e software correlati: file di configurazione, salvataggi, archivi di risorse e così via. La maggior parte di questi non è ancora stata documentata, né esistono...
posta 05.04.2014 - 23:09
4
risposte

Quali sono le cose che hai inserito in un documento di analisi dell'impatto?

Quindi stai correggendo i bug, quindi ne hai incontrato uno che potrebbe interessare altri moduli del prodotto software. I tuoi dati non sono sufficienti per supportare il tuo reclamo sugli effetti della correzione e ti è stato chiesto di creare...
posta 11.04.2011 - 03:35
2
risposte

Modo ASCIUTTO per scrivere Javadoc sui metodi di sovraccarico

Voglio scrivere Javadoc in modo ASCIUTTO. Ma il documento dell'oracolo su Javadoc dice di scrivere di nuovo la stessa cosa nel metodo di overload commento. Non posso evitare la ripetizione?     
posta 13.01.2012 - 03:25
5
risposte

Dove dovrebbe un programmatore spiegare la logica estesa dietro il codice?

Ho sviluppato alcune librerie quantitative in C # in cui è importante comprendere non solo le informazioni classiche che accompagnano i commenti XMLDoc (che contengono le informazioni di base con la firma del metodo) ma anche le formule matemati...
posta 05.04.2012 - 16:54
5
risposte

Un commento al metodo deve includere sia un sommario che una descrizione di ritorno quando sono spesso così simili?

Sono un sostenitore del codice correttamente documentato e Sono ben consapevole dei possibili svantaggi di esso . Questo è al di fuori dello scopo di questa domanda. Mi piace seguire la regola di aggiungere commenti XML per ogni membro pub...
posta 09.11.2011 - 14:33
3
risposte

È tipico per le aziende di software di grandi dimensioni non documentare o codice Refactor? [chiuso]

Ho iniziato a lavorare in una grande azienda di software e sono stato assegnato a un progetto di oltre un milione e mezzo di linee di codice. Fa parte di una suite di programmi che viene venduta ai clienti (non è un progetto interno) e il codice...
posta 27.11.2013 - 23:14
6
risposte

Qual è un buon esempio non tecnico di errore cumulativo?

Sto lavorando a una relazione che deve spiegare in termini non tecnici gli effetti di un errore cumulativo e perché è importante utilizzare calcoli assoluti. Definizione di "errore cumulativo" da dictionary.com : an error that gradually...
posta 20.02.2012 - 17:30