Autore Topic: Programma per la documentazione API REST  (Letto 554 volte)

Offline felasandroid

  • Utente normale
  • ***
  • Post: 345
    • Github
    • balduzziantonio
    • balduzziantonio.unifi
    • Mostra profilo
  • Dispositivo Android:
    Huawei P8 Lite
  • Play Store ID:
    FelasTech
  • Sistema operativo:
    Windows 10
Programma per la documentazione API REST
« il: 25 Marzo 2014, 11:36:03 CET »
Esiste un qualche programma per realizzare una documentazione di API ?

Offline iceweasel

  • Moderatore globale
  • Utente senior
  • *****
  • Post: 878
    • Mostra profilo
  • Dispositivo Android:
    LGE P990 - Google Nexus 5
  • Sistema operativo:
    Linux Debian Sid
Re:Programma per la documentazione API REST
« Risposta #1 il: 25 Marzo 2014, 13:36:18 CET »
JDK di Oracle ha Javadoc:

How to Write Doc Comments for the Javadoc Tool

ma io preferisco Doxygen:

Doxygen: Main Page
adb logcat | tee /tmp/logcat | grep TAG

Offline felasandroid

  • Utente normale
  • ***
  • Post: 345
    • Github
    • balduzziantonio
    • balduzziantonio.unifi
    • Mostra profilo
  • Dispositivo Android:
    Huawei P8 Lite
  • Play Store ID:
    FelasTech
  • Sistema operativo:
    Windows 10
Re:Programma per la documentazione API REST
« Risposta #2 il: 25 Marzo 2014, 13:52:55 CET »
JDK di Oracle ha Javadoc:

How to Write Doc Comments for the Javadoc Tool

ma io preferisco Doxygen:

Doxygen: Main Page

grazie! provo la seconda

Post unito: 25 Marzo 2014, 21:40:23 CET
JDK di Oracle ha Javadoc:

How to Write Doc Comments for the Javadoc Tool

ma io preferisco Doxygen:

Doxygen: Main Page

l'ho installato e mi ha generato una prima documentazione, notevole direi. Ora però se la voglio editare devo selezionare uno a uno i file HTML e modificarli?
« Ultima modifica: 25 Marzo 2014, 21:40:23 CET da felasandroid, Reason: Merged DoublePost »

Offline iceweasel

  • Moderatore globale
  • Utente senior
  • *****
  • Post: 878
    • Mostra profilo
  • Dispositivo Android:
    LGE P990 - Google Nexus 5
  • Sistema operativo:
    Linux Debian Sid
Re:Programma per la documentazione API REST
« Risposta #3 il: 26 Marzo 2014, 01:34:28 CET »
La documentazione viene scritta direttamente nei sorgenti, i file HTML sono generati automaticamente e se necessario ricreati.
adb logcat | tee /tmp/logcat | grep TAG

Offline felasandroid

  • Utente normale
  • ***
  • Post: 345
    • Github
    • balduzziantonio
    • balduzziantonio.unifi
    • Mostra profilo
  • Dispositivo Android:
    Huawei P8 Lite
  • Play Store ID:
    FelasTech
  • Sistema operativo:
    Windows 10
Re:Programma per la documentazione API REST
« Risposta #4 il: 26 Marzo 2014, 09:16:35 CET »
La documentazione viene scritta direttamente nei sorgenti, i file HTML sono generati automaticamente e se necessario ricreati.

si quello ci sono riuscito, solo che sto provando a inserire i commenti ad esempio prima dei metodi o classi però alcuni me li prende altri no..

ad esempio dopo le importazioni delle librerie ho messo

Codice (Java): [Seleziona]
/*
 @file   apiGeneral.java
 @author Antonio, email@email.com
 @version 1.0
 */

però non me lo prende..

o se volessi inserire una pagina con scritto le instruzioni per l'installazione è possibile?

Offline iceweasel

  • Moderatore globale
  • Utente senior
  • *****
  • Post: 878
    • Mostra profilo
  • Dispositivo Android:
    LGE P990 - Google Nexus 5
  • Sistema operativo:
    Linux Debian Sid
Re:Programma per la documentazione API REST
« Risposta #5 il: 26 Marzo 2014, 13:09:37 CET »
Quando si usa un nuovo programma è buona norma leggersi la documentazione e studiarsi gli esempi.

Quel commento non verrà mai processato perché non è rilevato, si tratta di un commento da non finire nella documentazione, per farlo rivelare da Doxygen e anche da Javadoc deve avere due asterischi all'inizio:

Codice (Java): [Seleziona]
/**
 *
 * .......
 *
 */

Molti editor e IDE hanno il supporto o dei plugin per generare in automatico il commento nel formato corretto con tutti i campi rilevati, poi basta aggiungere il testo opportuno.
adb logcat | tee /tmp/logcat | grep TAG