Domande con tag 'documentation'

domande con tag
2
risposte

Dovremmo includere servizi esterni in un diagramma di implementazione

Sto progettando un diagramma di distribuzione e un diagramma di componenti per un'applicazione Java EE esistente. L'app ha l'integrazione con 3 sistemi esterni tramite soap web services e ftp. Sto includendo questi sistemi nel diagramma de...
posta 28.10.2016 - 11:04
5
risposte

Qual è il modo migliore per comprendere il codice in un progetto con documentazione nulla?

È il nostro primo gioco e siamo una start-up. Avevamo un programmatore che all'improvviso sembra essere un peso morto. Anche se lo conoscevamo personalmente, pensavamo che fosse così motivato e quindi non ho mai cercato una recensione o una docu...
posta 22.04.2013 - 20:14
3
risposte

C'è una differenza tra le virgolette in "aiuto", "aiuto", "aiuto" e "aiuto"?

A volte trovo che nei file del codice sorgente i commenti abbiano delle virgolette come queste, si noti ': 'help' ''help" Ad esempio, questi sono commenti dal file di codice sorgente cat GNU, cat.c: /* Plain cat. Copies the file behind...
posta 08.02.2012 - 23:31
3
risposte

Come posso convincere i miei manager a far rispettare gli standard di documentazione?

Sto cercando di convincere un altro gruppo della mia azienda - che sta per consegnare il codice al mio gruppo - che hanno bisogno di fornire più documentazione nel loro codice sorgente, ma lo considerano un "bello da avere" . A mio avviso, è...
posta 17.11.2011 - 18:30
2
risposte

Contenuto del file AUTHORS

GNU raccomanda di creare un file AUTHORS per elencare gli autori e i contributori di un programma. Ma quanti "livelli" di autori e contributori dovrebbero contenere il file? Per esempio. se scrivo un programma foo che utilizza attivame...
posta 04.06.2012 - 17:15
2
risposte

Come ti adegui alle modifiche alle specifiche del prodotto durante lo sviluppo?

problema Le modifiche ai requisiti / alle specifiche del prodotto durante il ciclo di sviluppo sono inevitabili in un contesto professionale. In particolare, mi occupo costantemente delle modifiche alle specifiche dei parametri software di...
posta 10.08.2016 - 08:03
3
risposte

Quale livello di dettaglio utilizzare nelle descrizioni dei membri dell'interfaccia?

Sto estraendo interfacce da alcune classi in .NET e non sono completamente sicuro sul livello di dettaglio della descrizione da utilizzare per alcuni membri dell'interfaccia (proprietà, metodi). Un esempio: interface ISomeInterface { //...
posta 30.08.2012 - 12:14
3
risposte

Note sulla versione per la prima versione

Capisco cosa includere nelle comuni note di rilascio - ci sono molte domande e risposte relative a questo. Cosa dovrei includere nel primo set di note di rilascio, ad esempio per la prima versione rilasciata? Le note di rilascio sono necessar...
posta 20.02.2017 - 12:08
1
risposta

Commento PHPDoc, Class vs File

Sto cercando di standardizzare il mio codice il più possibile, compresi DocComments, usando PHPCS . Sembra che gli standard PEAR contengano due filtri che richiedono quasi esattamente gli stessi tag visualizzati nella classe e nei file DocBl...
posta 07.10.2015 - 15:09
2
risposte

Si consiglia di usare DocBlock anche se non sto usando phpDocumentor?

Sto sviluppando un sito Web semplice per un cliente. Ho letto di phpDocumentor e DocBlocks e ho pensato che la documentazione delle mie lezioni e funzioni sarebbe molto utile. Sono quasi sicuro che non non genererà alcuna documentazi...
posta 12.07.2012 - 22:48