Domande taggate «documentation»

La documentazione del software è un testo scritto che accompagna il software del computer. Spiega come funziona il software, come installarlo, come usarlo e altre risorse di aiuto.

8
Dovresti documentare tutto o solo la maggior parte?
Sembra un po 'un argomento controverso documentare tutto, inclusa la sintassi "JavaBean" di getter e setter per i campi: la gente dice che è inutilmente lungo e ripetitivo rompersi DRY (non ripeterti) , che la convenzione di denominazione dovrebbe spiegare tutto , e ingombra il codice / la documentazione. A …
4
Come documentare la struttura di alto livello di un programma Java?
Background: i miei collaboratori e io stiamo scrivendo un articolo per un diario accademico. Nel corso della nostra ricerca, abbiamo scritto un programma di simulazione in Java. Vogliamo rendere il programma di simulazione liberamente disponibile per essere utilizzato da altri. Abbiamo deciso di ospitare il codice su un repository GitHub. …
1
Duplicazione della documentazione sulle implementazioni / sostituzioni dell'interfaccia buona o cattiva?
Quindi abbiamo un'interfaccia simile /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Di recente, abbiamo riprodotto una storia di documentazione che …
4
Documentare la logica matematica nel codice
A volte, anche se non spesso, devo includere la logica matematica nel mio codice. I concetti utilizzati sono per lo più molto semplici, ma il codice risultante non lo è: molte variabili con scopi poco chiari e alcune operazioni con intenzioni non così ovvie. Non intendo dire che il codice …
6
Codice auto-documentante vs Javadocs?
Recentemente ho lavorato sul refactoring di parti della base di codice con cui sto attualmente trattando - non solo per capirlo meglio da solo, ma anche per renderlo più facile per gli altri che stanno lavorando al codice. Tendo a appoggiarmi al lato di pensare che il codice di auto-documentazione …
2
Quale standard ha sostituito 830-1998?
Ho esaminato come documentare i progetti software in modo più formale e ho appreso IEEE 830-1998: pratica consigliata per le specifiche dei requisiti software . Tuttavia, come puoi vedere da quel link, è stato sostituito. So che 830-1998, e probabilmente anche 830-1993, sono probabilmente adatti all'uso. Tuttavia, se non altro, …
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.