search

Fs00 / rpg-game-4inc

Didactic and highly experimental Java CLI RPG game made by a bunch of IT students.
0 stars 0 forks source link

Gestione della documentazione #8

Closed alegotta closed 6 years ago

alegotta commented 6 years ago

Proporrei di generare la documentazione che scriviamo con JavaDoc nella cartella /docs (da creare) Poi @Fs00 dovrebbe abilitare Github Pages in modo che possa essere visibile da chiunque.

Oltre al JavaDoc, a gioco finito si può pensare di aggiungere una piccola spiegazione del funzionamento del gioco ed alcuni screenshot nel ReadMe.

Fs00 commented 6 years ago

Sulla cartella /docs quoto in toto, invece che GitHub Pages la mia intenzione era quella di fare una wiki, molto più facile e veloce da gestire. In caso gli screenshots li mettiamo là, invece che nel Readme (che è più ad un livello sviluppatore).

alegotta commented 6 years ago

Ok per la Wiki. Mi sono spiegato male, GitHub Pages servirebbe solo per visualizzare il JavaDoc renderizzato dal browser (altrimenti si vede solo il codice html in plain text, che non è il massimo).

Fs00 commented 6 years ago

Ah ok, buona idea, ci penseremo.

Fs00 commented 6 years ago

Riapro per assegnare ad @alegotta la creazione della pagina GitHub Pages e della cartella docs per il Javadoc. Da richiudere quando il lavoro in questo senso sarà completato.

alegotta commented 6 years ago

Io non posso gestire Github Pages, questa funzione è esclusiva del proprietario del repo (@Fs00). Ok per il resto.

Fs00 commented 6 years ago

Ho creato il sito GitHub Pages (fs00.github.io/rpg-game-4inc) con il Javadoc e le pagine mancanti nella wiki. Chiudo l'issue, dato che il grosso è stato fatto. In caso di informazioni da aggiornare/completare, ne parleremo quando ci si vede.

Fs00 commented 6 years ago

@alegotta Sarebbe buono se integrassi la Javadoc con le descrizioni relative ai package, come in questo link: https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java. Inoltre, quando puoi, revisiona/integra le documentazioni delle classi in modo da evitare di lasciare "buchi".

Fs00 commented 6 years ago

Ottimo, chiudo.