Domande con tag 'documentation'

domande con tag
1
risposta

Quali informazioni devono essere inserite nel blocco del documento a livello di file?

Principalmente sviluppo per Node.js. Ho preso l'abitudine di mettere un docblock a livello di file in tutti i miei file .js . Sembra qualcosa del genere: /** * project-name * * Licensed under the BSD-3-Clause license * For full copyright...
posta 07.06.2015 - 23:31
1
risposta

Riferimenti alla documentazione ufficiale nella documentazione del codice sorgente

Quali sono le tue preferenze per referenziare la documentazione ufficiale (come un white paper) per un algoritmo dai commenti in il codice che lo implementa? Sto cercando di decidere tra due metodi, come illustrato dagli esempi di seguito, ma so...
posta 09.07.2014 - 01:18
2
risposte

Come devo documentare un'applicazione multilivello?

Devo creare una struttura di documentazione per un'applicazione legacy e non sono sicuro di come organizzarlo. Obiettivi della documentazione : Elenco dei casi d'uso Flusso del programma per ciascuno dei casi d'uso. ( Diagramma di flusso...
posta 20.03.2014 - 12:20
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

come mappare controllori, modelli e viste come un elenco di cose da fare

Prima di iniziare un progetto in corso mi chiedevo se esiste una terminologia per ciò che sto pensando di fare? Fondamentalmente quello che voglio fare è mappare ogni oggetto in livelli come tutti i controller e come verranno chiamati, i metodi...
posta 19.05.2013 - 00:23
4
risposte

Design Document From Code

Non ho molta familiarità con la documentazione / progettazione di sistemi. Devo mantenere un'applicazione scritta in C # - funziona come un servizio Windows. Tuttavia non esiste documentazione per questo sistema che renda veramente patetico...
posta 22.12.2011 - 07:48
1
risposta

Come conservare i nomi dei parametri quando si utilizza bind per definire nuovi metodi

Sto scrivendo un oggetto javascript che racchiude le richieste REST. Per ogni operazione sul server esiste un metodo che accetta i parametri per la richiesta e un callback che riceverà i risultati. (Il metodo invia un jQuery $.ajax() -call...
posta 03.11.2016 - 12:30
1
risposta

Utilità di Javadoc con test unitario?

Sono sicuro che qualcun altro ha riscontrato il problema della documentazione relativa ai test unitari. Mi stavo chiedendo se qualcuno ha usato javadocs con i loro test unitari per generare i propri file javadoc interni per tenere traccia e docu...
posta 08.07.2011 - 03:41
6
risposte

Metodologia per documentare la base di codice esistente

Lavoro come parte di un team su un'applicazione esistente che non ha documentazione in linea e non ha documentazione tecnica. Come ho lavorato su vari bug report sull'applicazione, ho scritto una sorta di traccia di breadcrumb per me stesso - nu...
posta 18.11.2008 - 19:02
0
risposte

Aggiunta di documentazione dopo la modifica del codice

Nel nostro TFS (versione 14.102.25423.0) posso fare clic su Sfoglia sulla home page, quindi su Cerca server, selezionare il mio progetto e premere Naviga. Una volta all'interno del mio progetto, vedo schede come Home Code Work Build...
posta 24.02.2017 - 23:14