Domande con tag 'documentation-generation'

domande con tag
1
risposta

La documentazione generata dovrebbe andare nella cronologia del controllo della versione?

Sono contrario alle cose compilate che entrano nel controllo della versione, specialmente quando si tratta di binari compilati, tuttavia, i miei principi sono ora in discussione dopo l'aggiunta del supporto di doxygen per un progetto. Le cent...
posta 13.11.2012 - 22:28
2
risposte

è la documentazione XML utilizzata per documentare solo l'API esterna?

Sto usando i commenti della documentazione XML per documentare un nuovo progetto. Tutti i miei metodi API pubblici sono documentati utilizzando le tre barre richieste per la documentazione XML. I miei metodi interni (protetti e privati) sono...
posta 05.01.2018 - 17:09
3
risposte

Code mapping in .NET (o in generale)

Esiste una soluzione software di qualche forma che ha la capacità di mappare le azioni di chiamata a una funzione. Quindi intendo dire, diciamo che abbiamo la seguente classe. public class Foo { public Foo() { if (this.SomePr...
posta 11.07.2011 - 21:50
1
risposta

Come documentare parametri illimitati di argomenti?

In PHP puoi avere una funzione che accetta un numero infinito di argomenti come /** * Do abc... * * @since 1.0 * @param mixed $arg1 Arg description * @return string Results */ function abc($arg1 = null...
posta 19.07.2012 - 21:41
1
risposta

Generazione documentazione - FiM ++

Questa è una domanda che ho originariamente chiesto su Stack Overflow, ma come domanda di progettazione concettuale e non tecnica, credo che potrebbe essere più appropriato, o possibilmente avere un valore parallelo alternativo, su questa sched...
posta 18.01.2013 - 06:21
2
risposte

Quante informazioni deve contenere una docstring

Ho una funzione che accetta come argomenti un certo numero di classi di complessità media. Durante la scrittura di docstring per quella funzione, mi imbatto in una serie di domande: dovrei descrivere (oltre a ciò che sta facendo la funzione)...
posta 13.04.2018 - 11:31
1
risposta

Come scrivere una documentazione adeguata per i riferimenti in un docblock? [chiuso]

Sto aggiungendo la documentazione al codice PHP usando lo strumento phpDocs: /** * This is a summary * * This is a description * * @use This function is called here and here */ function doSomething(){ } Mi sto solo chiedendo se voglio agg...
posta 11.06.2015 - 21:00
1
risposta

La documentazione non dovrebbe essere scritta insieme ai test piuttosto che nel codice?

È molto comune scrivere la documentazione nello stesso file del codice ed estrarla utilizzando il software per generare documenti. Per non influire sulle prestazioni, la documentazione è scritta all'interno di righe commentate, in un DSL progett...
posta 07.07.2013 - 15:30
1
risposta

Quando e perché durante la reingegnerizzazione del software a volte la ricostruzione del documento viene saltata?

Mentre studiavo il libro di Ingegneria del software dell'autrice Roger Pressman, mi sono imbattuto in questo punto sulla reingegnerizzazione del software, in cui è scritto nel libro che se la creazione di documentazione richiede molto tempo, all...
posta 15.10.2017 - 11:08
4
risposte

Utility di documentazione per OpenEdge ABL

Ho un grande sistema in OpenEdge ABL che potrebbe usare un po 'di documentazione-amore. Attualmente un membro del team sta lavorando a un'utilità che può trovare metodi e funzioni e creare alcune pagine html "Javadoc-esque". È piuttosto ruvido...
posta 15.06.2011 - 22:35