Qualcuno conosce dei software per mac per creare manuali per programmi?
Oppure sapete darmi delle dritte su cosa mettere o su cosa omettere?
Grazie
Printable View
Qualcuno conosce dei software per mac per creare manuali per programmi?
Oppure sapete darmi delle dritte su cosa mettere o su cosa omettere?
Grazie
software per un manuale? io farei un semplice pdf...
Ma su cosa, su quale argomento?:roll:Citazione:
Originalmente inviato da sql
Intendi file help?
Dipende molto da cosa devi fare... ti posso dire che se usi Java hai la possibilita' di sviluppare una documentazione del software contemporaneamente al suo sviluppo, grazie agli strumenti Javadoc. Tutto quello che devi fare e' semplicemente inserire dei "commenti" tipo questo:Poi, per generare la documentazione, ti basta dare da linea di comando javadoc NomeSorgente.java e vengono automaticamente generati tutti i file di documentazione.Codice:/**
Breve descrizione della classe
Descrizione approfondita della classe
@author Il tuo nome o simile
@version la versione del programma
*/
public class NomeClasse extends ... implements ... { ... }
/**
Breve descrizione del metodo
Descrizione approfondita della funzione (va bene anche codice HTML se lo conosci)
@param nome_parametro descrizione_parametro
@param ... (ripeti come prima per ciascun parametro)
@return descrizione del valore restituito, se presente
@exception NomeEccezione se il tuo metodo solleva qualche eccezione e in quali condizioni
@exception ... (ripeti come prima per tutte le eccezioni)
*/
public int method (int x, int y) { ... }
/**
Breve descrizione della variabile
Descrizione approfondita della variabile (va bene anche codice HTML)
*/
publid double var;
Stammi bene...
Io dovrei fare un manuale pdf per un programma fatto in filemaker.
Questo manuale dovrebbe spiegarne il funzionamento.
Sto cercando magari degli esempi su come organizzarlo.