Domande con tag 'documentation-generation'

domande con tag
2
risposte

HTML nei commenti docblock?

Negli standard PEAR non esiste alcun riferimento all'HTML, se consentito o meno. link Ma vedo che alcune persone usano tag HTML come <kbd> e cose .. Quindi l'HTML è permesso? Si romperà alcuni parser di documenti?     
posta 18.07.2012 - 20:52
2
risposte

Il modo migliore per gestire i minuti di riunione

Qual è il modo migliore di gestire i minuti di riunione su basi giornaliere? Dobbiamo gestire i documenti in un repository come VSS o può essere mantenuto in un foglio Excel stesso. Gentilmente condividi la tua esperienza per lo stesso e per...
posta 07.03.2011 - 10:06
0
risposte

Standard per l'ordine dei tag in PHP DocBlocks?

In base ai tag elencati da questo "standard" , c'è un ordine dei tag che le persone seguono in genere? Anche se non è qualcosa che è stato interamente accettato, ma qualcosa proposto? Sto cercando di far rispettare uno standard di codifica per...
posta 22.09.2015 - 17:52
2
risposte

Esiste una gestione della documentazione API?

Quindi ho iniziato a pensare, qual è la best practice per la pubblicazione di documentazione generata (ad esempio Doxygen, NaturalDocs, ecc.) in termini di infrastruttura? Lo genererei attraverso l'integrazione continua: Dovrebbe essere i...
posta 18.06.2014 - 08:25
1
risposta

Come incorporare un articolo nel codice sorgente?

A volte, ho notato errori di battitura negli articoli (post del blog) o libri nel codice sorgente che appare nel corpo dell'articolo. Potrebbe essere un'indicazione che il codice è stato copiato e incollato manualmente (ad esempio, parentesi gra...
posta 16.04.2013 - 12:41
1
risposta

Classificazione del tipo di componente software [chiusa]

Sto scrivendo un framework che documenta automaticamente le dipendenze delle applicazioni in un sistema distribuito, l'idea è di produrre qualcosa vicino a un diagramma di componenti UML di l'intero sistema in fase di esecuzione. I componen...
posta 16.03.2017 - 18:29
2
risposte

Come scrivere commenti per spiegare il "perché" dietro la funzione di callback quando i nomi di funzione e parametro sono insufficienti?

Come dovrei avvicinarmi ai commenti di scrittura per le funzioni di callback? Voglio spiegare il "perché" dietro la funzione quando i nomi di funzione e parametro sono insufficienti per spiegare cosa sta succedendo. Mi sono sempre chiesto per...
posta 17.09.2013 - 04:26
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
2
risposte

Documentazione del codice C incorporato

Sto avviando una startup e io ei miei partner stiamo avendo problemi a tenerci aggiornati sul reciproco codice e su come implementare le loro funzioni. Il nostro codice è molto ben commentato, ma ognuno di noi ha scritto oltre 100 funzioni, e st...
posta 23.12.2016 - 16:26
1
risposta

Commenti di documentazione aggregati da più script in README?

Dopo aver scritto alcuni script Python con commenti per la documentazione all'interno, è una buona idea e possibile aggregare i commenti della documentazione da più script in qualche file di documentazione standalone come README? Inoltre, è p...
posta 19.03.2015 - 17:09