documentation-generation

13calore

2risposta

Prima metodi Java abbiamo qualcosa di simile: /** * Takes a number and returns its square root. * @param x The value to square. * @return The square root of the given number. */ public float getS

27calore

2risposta

Come documentare il codice Python: Epydoc, doxygen, Sfinge, ...?

Non sono sicuro se dovrei usare Epydoc o doxygen per documentare il mio codice Python. Attualmente preferirei Epydoc dato che è specializzato in Python e la sua sintassi non è molto diversa da quella

16calore

1risposta

Che generatore di documentazione utilizza Google?

Google ha una documentazione uniforme di tutte le sue API. Mi chiedo quale generatore di documentazione usi e sia disponibile per uso pubblico. Ha un buon TOC e altre caratteristiche. Anche il codice

5calore

1risposta

Come posso creare un file che documenta solo le API "pubbliche" in Doxygen

Ho un progetto su cui sto lavorando e che è una libreria . Devo documentare le parti interne del codice della libreria per i miei scopi, ma devo anche consegnare un documento API ai miei utenti su com

7calore

1risposta

Come si ottiene la documentazione XML da mostrare per una libreria C# di riferimento?

Supponiamo di disporre di una libreria C# con diverse funzioni, tutte documentate con il solito /// <summary> compilato correttamente. Fare riferimento al progetto farà apparire la funzione e la descr

47calore

3risposta

Generazione automatica di documentazione per tutto il pacchetto Python Contenuto

Sto provando a generare automaticamente la documentazione di base per il mio codebase utilizzando Sphinx. Tuttavia, ho difficoltà a istruire Sphinx a scansionare ricorsivamente i miei file. Ho un base

5calore

2risposta

Utilizzo di Doc-O-Matic (Express) con Delphi

Sto cercando uno strumento per generare documentazione del codice sorgente Delphi e voglio provare a Doc-O-Matic Express (che è gratuito). Esistono linee guida per i principianti su come utilizzare Do

6calore

6risposta

Quale strumento/quadro utilizzare per la documentazione tecnica?

Sviluppiamo prodotti e strutture da utilizzare con la nostra organizzazione. Sto cercando strumenti di documentazione amichevoli per i programmatori. Ho fatto qualche ricerca su alcune opzioni prima,

28calore

5risposta

C++: dove scrivere la documentazione del codice: in .cpp o in file .hpp?

Dove è usuale scrivere la documentazione in codice di classi e metodi? Si scrivono tali blocchi di documenti sopra la classe/metodo corrispondente nel file di intestazione (.hpp) o nel file di origine

18calore

4risposta

VS2010: file generati automaticamente e documentazione XML

Questo è davvero solo ri-chiedere this question asked about Visual Studio 2008. VS2010 offre funzionalità per eliminare l'avviso del compilatore CS1591 per il codice generato automaticamente? CS1591: