Domande con tag 'documentation'

domande con tag
1
risposta

I commenti di riepilogo dei file sono un buon modo per sapere cosa fa ciascun file?

Voglio sapere se includere un commento di riepilogo del file all'inizio di ogni file è un buon modo per sapere cosa fa ogni file o c'è un modo migliore.     
posta 02.10.2018 - 22:14
2
risposte

quale strumento o metodologia usare per eseguire l'analisi di impatto in un sistema distribuito?

Stiamo lavorando su un grande sistema (legacy) distribuito con varie applicazioni, messaggistica (servizi di soap, database dblinks, servizi di riposo) ... Ci manca la documentazione e una visione ampia di questo complesso sistema. e stiamo cerc...
posta 25.01.2018 - 21:18
1
risposta

Come evitare la ripetizione nelle docstring?

Trovo che nel mio codice, molti metodi in una classe o un insieme di classi correlate abbiano argomenti abbastanza simili: Arguments: dt_start (datetime): Starting date. Needs to meet complex requirements x and y and z. If not p then q or...
posta 25.02.2016 - 21:59
1
risposta

Come posso trovare le risorse fornite da un contenitore Java EE?

Come posso trovare cosa "Risorse" fornisce un contenitore Java EE? Posso scoprire questo a livello di programmazione, o c'è documentazione a cui dovrei fare riferimento? (Si noti che il tutorial Java EE è vago su questo argomento.) Ecco un es...
posta 12.04.2015 - 20:33
2
risposte

Quando scrivere la documentazione del progetto software sul codice [duplicato]

Di solito scrivo i miei progetti software in java, e sono ancora un po 'confuso su quando documentare le mie classi, interfacce e metodi. Ci sono due modi: 1) Scrivi la documentazione dopo aver dichiarato o codificato una classe / inte...
posta 20.11.2013 - 11:53
1
risposta

Conversione da web a PhoneGap

Stavo passando per il PhonGap Documentation su come impacchettare il HTML/JS/CSS su una% specifica di piattaforma specifica%. Hanno mantenuto documentazioni separate per le versioni separate "native app" che sembra soddisfacente....
posta 01.08.2013 - 15:16
2
risposte

Come scrivere condizionali descrittivi per ifs?

Ho preso l'abitudine di usare nomi eccessivamente descrittivi. Inoltre, ho anche preso l'abitudine di creare le condizioni per if in questo modo: bool user_is_female = user.get_gender() == GENDER_FEMALE; bool user_is_warrior = user.get_unit_c...
posta 21.03.2014 - 20:06
3
risposte

Quale metodo di visualizzazione consiglieresti per i programmi guidati dagli eventi?

Quale metodo di visualizzazione consiglieresti per i programmi guidati dagli eventi? Esistono diagrammi standard del settore, come i diagrammi di flusso?     
posta 25.12.2011 - 10:27
4
risposte

Quali standard utilizza la tua squadra per le intestazioni e i footer dei documenti delle specifiche?

TL; DR: Quale intestazione / piè di pagina inserisci sulle tue Specifiche tecniche funzionali e tecniche per evitare che persone che hanno versioni diverse durante le riunioni? Story: Abbiamo molti documenti, cambiati da tutti. Specific...
posta 07.09.2011 - 18:14
2
risposte

come possiamo migliorare la documentazione del progetto

Stiamo progettando di sviluppare un'API di database per il nostro progetto. Voglio sapere come possiamo migliorare la nostra documentazione. La struttura corrente di un documento è: Introduction : Database Objects :List Each Object (Table)...
posta 22.01.2011 - 09:27