Thejuster (Admin)
Guru^2
Messaggi: 2298
Iscritto: 04/05/2008
|
Buongiorno a tutti.
Sto cercando una piattaforma web gratuita che mi permetta di creare delle documentazioni tipo msdn
Ho provato dioxide, funziona ma è molto contorto.
cerco qualcosa dove posso spiegare come funziona il mio engine e la relativa sintassi di script.
tempo fà avevo scelto wikipedia.
Ma è stata una scelta pessima.
Dopo tutto quel lavoro nel scrivere la documentazione, I bot ci hanno dato sotto distruggendo tutto.
e spammando a piena forza.
ho trovato per caso
Doc-as-Code qualcuno sà come funziona?
o come posso ottenere qualcosa del genere?
I comandi sono veramente tantissimi.
E vorrei elaborare una guida dettagliata per gli utenti che intraprendono lo studio di MMORpgmaker.
|
|
Roby94 (Member)
Guru
Messaggi: 1170
Iscritto: 28/12/2009
|
Per ogni repository GitHub ti permette di creare una wiki, ovviamente ha senso se il codice è disponibile su GitHub.
Non mi sorprende che da Wikipedia te l'abbiano rimosso immediatamente, non è il luogo per postare documentazione tecnica su un programma.
E sopratutto Wikipedia è una fonte terziaria di informazioni, niente pubblicazioni completamente originali.
Ultima modifica effettuata da Roby94 il 21/02/2016 alle 15:13 |
|
TheDarkJuster (Member)
Guru^2
Messaggi: 1620
Iscritto: 27/09/2013
|
Per la documentazione del codice c'è doxygen, trasforma i commenti in documentazione e lascia la possibilità di aggiungere "pagine scritte a mano" in formato markdown e/o HTML.
Vedi http://www.stack.nl/~dimitri/doxygen/ per ulteriori informazioni.
Il sito di doxygen è fatto usando doxygen, quindi puoi vedere che è possibile creare documentazione da qualcosa di diverso di un progetto, ma questo non esclude di poter fare entrambe le cose......
Doxygen è compatibile con i più famosi linguaggi di programmazione.
La trovo una ottima soluzione per il mantenimento della documentazione.
|
|
Thejuster (Admin)
Guru^2
Messaggi: 2298
Iscritto: 04/05/2008
|
Postato originariamente da Roby94:
Per ogni repository GitHub ti permette di creare una wiki, ovviamente ha senso se il codice è disponibile su GitHub.
Non mi sorprende che da Wikipedia te l'abbiano rimosso immediatamente, non è il luogo per postare documentazione tecnica su un programma.
E sopratutto Wikipedia è una fonte terziaria di informazioni, niente pubblicazioni completamente originali. |
Questo lo sò che su wikipedia non puoi scrivere articoli personali XD
Avevo scaricato wikipedia ed installato nel mio webserver.
ma i bot hanno fatto piazza pulita.
Poi lo vedo abbastanza complicato da capire.
Forse conviene scrivermi una sorta di msdn personale
così faccio prima.
Dyoxigen e buono. L'ho provato.
Ma me serviva specificare l'aiuto non per il codice sorgente, ma per lo scripting lua.
Avendo registrato diversi tipi di dato e svariate funzioni, il mio obiettivo era quello di creare una guida al linguaggio
per lo scripting dedicato al mio engine.
esempio
Codice sorgente - presumibilmente VB.NET |
--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=-- -- ** Window_Selectable -------------------------------------------------------------------------------- -- This window class contains cursor movement and scroll functions. --=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=-- require "Std_Lib" --> Libreria Statica per funzioni basilari Window_Selectable = {} item_height = 24 -- da funzionificare!!! mi secca farlo ora ^.^ function Window_Selectable.Initialize() end function Window_Selectable.Col_Max() return 2 end function Window_Selectable.Spacing() return 32 end function Window_Selectable.Item_Width() iw = math.floor(((Screen.Get_Width() - (Window.Standard_Padding() * 4)) / (Window_Selectable.Col_Max()) - Window_Selectable.Spacing())) return iw end function Window_Selectable.Draw_Command(wx, wy, item_max) for index = 0, item_max - 1, 1 do col_max = Window_Selectable.Col_Max() item_width = Window_Selectable.Item_Width() spacing = Window_Selectable.Spacing() x = wx + (index % col_max * (item_width + spacing)) y = wy + (math.floor(index / col_max) * item_height) w = item_width h = item_height text = "Test_Item" -- poi sarebbe item[i].name o simili Window.Draw_Selec_Comm(x, y, w, h, text) end end
|
questo script lo ha realizzato un mio collaboratore che permette di avere delle finestre selezionabili con un cursore.
Chiunque prova a guardarlo potrebbe capirci poco o nulla.
Ma ogni definizione ha un suo preciso comportamento ed'è questo quello che intendo fare.
specificare ogni istruzione cosa fà, e quali parametri accetta.
|
|
TheDarkJuster (Member)
Guru^2
Messaggi: 1620
Iscritto: 27/09/2013
|
|
|
Thejuster (Admin)
Guru^2
Messaggi: 2298
Iscritto: 04/05/2008
|
Grazie DarkJuster lo provo subito.
|
|
TheDarkJuster (Member)
Guru^2
Messaggi: 1620
Iscritto: 27/09/2013
|
Ma ora che ci penso la firma della funzione la puoi scrivere anche in c è utilizzare doxygen..... Insomma.... Così potresti creare una documentazione mista alla guida generale....
Non devi nemmeno creare i file c è compilarli, bastano gli Header con la firma e fai leggere quelli a doxygen, così è ancora più elegante e semplice, no?
|
|
Thejuster (Admin)
Guru^2
Messaggi: 2298
Iscritto: 04/05/2008
|
Ho provato ma il risultato finale non mi soddisfa.
Mi tocca creare una documentazione a mano.
Così sono sicuro che uscirà quel che voglio.
Grazie dell'aiuto Juser ma devo scriverla per forza maggiore manualmente.
le funzioni non sono tantissime per ora.
Man mano che implemento nuove operazioni al parser lua scrivo la sua funzionalità
|
|
TheDarkJuster (Member)
Guru^2
Messaggi: 1620
Iscritto: 27/09/2013
|
Perchè non ti soddisfa?
Posso vedere se c'è qualcosa di più adatto.... Ma usare doxygen mi sembra una ottima soluzione.... Se è per il tema grafica so può cambiare.........
|
|