Domande con tag 'documentation'

domande con tag
1
risposta

Qual è l'origine della frase "estirpata come potenziale munizione"

Recentemente ho trovato questa affermazione nella documentazione di Perl: extirpated as a potential munition derivato dalla frase: "Crea una stringa di digest esattamente come la funzione crypt (3) nella libreria C (assumendo che in...
posta 10.03.2015 - 01:29
4
risposte

Devo usare il tempo futuro o presente quando scrivo un documento di progettazione?

Sto scrivendo un documento di specifiche di progettazione per un progetto universitario e mi sto chiedendo quale sia il tempo che dovrei usare. Lo sviluppo del progetto non è ancora iniziato, sto solo scrivendo la sezione di progettazione dell'i...
posta 04.11.2015 - 19:52
3
risposte

Come si pluralizza vedere cref="Notazione"?

Qual è il modo più appropriato di scrivere questo commento: /// <summary> /// Order - Identifies the ordinal location of this category /// relative to other listed categories. /// </summary> se voglio racchiu...
posta 16.02.2011 - 19:48
2
risposte

Wiki / markup in azienda come documentazione [chiusa]

Perché è meno comune utilizzare wiki / markup in azienda come documentazione? Utilizzano invece un documento Word. Wiki / markup sono in formato testo, che è adatto al controllo della versione.     
posta 19.12.2012 - 07:36
3
risposte

Creazione di un progetto per un progetto open source

Quindi ho un progetto open source che vorrei promuovere e voglio creare un sito per il progetto dove ospiterò la documentazione, ecc. (preferibilmente qualcosa che si integra con github per gestire download, problemi, ecc. ). Il sito del progett...
posta 26.08.2011 - 08:49
3
risposte

Generazione della documentazione del codice [chiusa]

Voglio generare la documentazione del codice in un formato semplice. Gli elementi chiave sono Method Signature, membri, costruttori, metodi. Sto prendendo varie applicazioni in .NET e creando documentazione per loro. Aggiungerò note a ciascun ar...
posta 27.02.2012 - 16:56
3
risposte

Come scrivo una specifica? [duplicare]

Con così tanti progetti che cambiano a metà strada - e i clienti ritengono che molto possa essere cambiato senza costi aggiuntivi - vorrei iniziare a scrivere specifiche. Tuttavia, non l'ho mai fatto prima e non so molto delle nozioni di bas...
posta 27.01.2012 - 00:06
2
risposte

Il README della mia applicazione dovrebbe essere per sviluppatori o utenti

La mia applicazione è pensata per essere utilizzata da normali utenti di tutti i giorni, ma può anche essere modificata liberamente dagli sviluppatori. Questi due segmenti di pubblico (utenti e sviluppatori) richiedono informazioni diverse. I...
posta 30.04.2015 - 23:44
2
risposte

Mi aspettavo che l'utente API implementasse un UnsupportedOperationException ok?

Sto scrivendo un gestore per il download / l'importazione di dati. Dopo aver inserito i dati nel database, è possibile chiamare diversi lavori di importazione, ma solitamente è solo uno. Quindi ci sono due metodi per ottenere i lavori di importa...
posta 09.12.2016 - 16:45
2
risposte

Devo documentare gli operatori sovraccarichi in C #?

Quindi ho lavorato su una libreria C # Matrix. Finora l'ho documentato davvero bene. Il fatto è che non so se dovrei documentare i miei operatori sovraccaricati, voglio dire, è abbastanza ovvio, non è vero? Codice di esempio: public stat...
posta 29.06.2016 - 23:55