Domande con tag 'documentation-generation'

domande con tag
5
risposte

Come convincere la compagnia a iniziare la documentazione per il software legacy [duplicato]

È passato meno di un anno da quando sono entrato nella mia attuale compagnia. La maggior parte delle vendite proviene da un singolo prodotto che è rimasto in vita negli ultimi 10 anni. Tuttavia, c'è una documentazione minima (se non del tutto)...
posta 02.02.2012 - 14:35
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

Duplicazione della documentazione sulle implementazioni dell'interfaccia / annullamento buono o cattivo?

Quindi abbiamo un'interfaccia come questa /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(...
posta 04.04.2013 - 17:31
8
risposte

Dove mettere la documentazione del codice?

Attualmente sto usando due sistemi per scrivere la documentazione del codice (sto usando C ++): La documentazione sui metodi e i membri della classe vengono aggiunti accanto al codice, utilizzando il formato Doxygen. Su un server Doxygen vie...
posta 11.06.2012 - 11:00
3
risposte

Come documentare API sperimentali o incomplete come @deprecated?

Esiste un termine valido che è simile ma diverso da "deprecate" per indicare che un metodo o un'API si trova nella base del codice ma non dovrebbe essere utilizzato perché la sua implementazione non è completa o probabilmente cambierà? (Sì, lo s...
posta 15.10.2012 - 21:38
5
risposte

Quali sono i deliverable da fornire al client per un'applicazione web? [chiuso]

Ho completato un'applicazione web che è fondamentalmente sviluppata in PHP ed è solo un'altra normale applicazione web. Di solito quando consegna la versione finale della produzione, passo semplicemente a consegnare la documentazione del codice...
posta 01.09.2011 - 16:24
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
1
risposta

I modelli di supporto di doxygen per l'output HTML?

Ho documentato il mio codice per doxygen , ma non voglio il codice HTML predefinito che fornisce. So che posso personalizzarlo fornendo CSS, intestazioni, footers, ecc. Personalizzati (come fa GNOME), e come posso aggiungere codice PHP comun...
posta 06.03.2013 - 19:43
2
risposte

Mantiene la versione della documentazione uguale alla versione del progetto

Oltre a questa domanda Git deve essere utilizzato per la documentazione e la gestione dei progetti? Il codice dovrebbe essere in un repository separato? Voglio chiedere se è consigliabile mantenere la versione della documentazione (ad esempi...
posta 27.03.2017 - 23:15
1
risposta

Formato di documentazione del codice standardizzato, dov'è? [chiuso]

Attualmente sto esaminando gli strumenti di generazione di documentazione API e ho notato che apparentemente non ci sono sforzi in corso nella standardizzazione. Lo stile Javadoc è una specie di convenzione onnipresente ... è usato per Java...
posta 08.05.2012 - 03:51