Sandcastle - ancora la cosa giusta da usare? O ci sono alternative? [chiuso]
https://stackoverflow.com/questions/986741
-
13-09-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianDomanda
Mi chiedo solo - l'ultima release di Sandcastle è dal maggio 2008, ed è ancora indicato come pre-Release Software / CTP e non è nemmeno concesso in licenza più, come l'EULA dice specifially:
2.Menzione. La durata del presente accordo è fino al 1 settembre 2007 o versione commerciale del software, a seconda di quale è il primo.
Come Sandcastle è piuttosto "pesante" in ogni caso, mi chiedo se è ancora la cosa giusta da usare, o se ci sono alternative per creare xmlDoc documentazione? (Alternative = qualcosa che può essere eseguito dal mio build per generare almeno HTML, preferibilmente PDF pure).
Soluzione
Nessuno menzionato Docu, un recente progetto avviato da James Gregory, dev vantaggio al FluentNHibernate.
E 'molto semplice e facile da usare strumento che genera documentazione HTML a la rdoc . Si può facilmente modificare i modelli dal Docu utilizza Spark come il motore di visualizzazione.
Questa è la FluentNHibernate documentazione costruito con Docu.
Altri suggerimenti
Microsoft Sandcastle è sicuramente ancora la strada giusta da percorrere. L'alternativa principale (che offre qualcosa di vicino al set di funzionalità di Castello di sabbia) è NDoc , ma l'ultima release di che è molto più antica, essendo nel gennaio 2005!
Anche se è ancora tecnicamente in (tardiva) fase di pre-release, in realtà è uno strumento abbastanza stabile. Il piccolo numero di bug sono stati corretti dalla patch, disponibile su CodePlex come parte dei Stili Sandcastle progetto. C'è anche un superbo GUI per esso, vale a dire Sandcastle Aiuto Builder File .
Non sono sicuro circa il futuro sviluppo di Sandcastle però. Credo che sia probabile che Microsoft continuerà a lavorare / espansione su di esso ad un certo punto, anche se non sembra esserci alcuna notizia di quando. E 'certamente l'unico strumento decente per la creazione di documentazione adeguata per una libreria .NET o applicazione, al momento. Naturalmente spesso è possibile ottenere via con più strumenti "leggeri" per i piccoli progetti / file di aiuto. Le principali alternative che ho notato sono sia commerciali e inferiore al Sandcastle.
Documentazione Generazione a mano / utilizzando l'automazione personalizzato è probabilmente fattibile in alcuni casi, ma solo per i progetti di piccole dimensioni (che non sono suscettibili di espandersi.)
Per quanto io sappia, Castello di sabbia è ancora una scelta valida. Ho usato molte volte nel recente passato e non hanno problemi. È possibile controllare questa pagina su MSDN e scorrere fino alla sezione 'Documentazione' per altre buone scelte:
Per utilizzare in modo efficace Sandcastle è necessario, come Noldorin sottolineato in precedenza, di usare anche gli stili Sandcastle e Sandcastle file di aiuto Builder (SHFB). Tutti avevano una nuova release a metà del 2010 così sono sicuramente strumenti attuali.
Anche con l'interfaccia grafica semplice e pulito fornito da SHFB, tuttavia, ci sono un certo numero di problemi che potrebbe essere necessario o prendere in considerazione al fine di produrre un ordine, documentazione professionale. Il mio articolo ( " bisbetica Sandcastle: Guida del .NET Programmer documentazione del codice ") che documenta la mia esperienza con una varietà di potenziali insidie, pubblicato su Simple-Talk.com nel settembre 2010, può salvare po 'di tempo, fatica e angoscia: -).
Un'altra risorsa utile: Nell'ottobre 2010 ho seguito l'articolo con una di una pagina grafico muro che riassume la documentazione XML commento lessico per SHFB.
DocProject vale la pena dare un'occhiata a. Si toglie un sacco di dolore di lavorare con castello di sabbia.
Ho messo un breve elenco di alcuni strumenti di documentazione in questa domanda SO: chiunque-using- NDoc-or-a-simile-tool
Credo SandCastle è il miglior strumento opensource attualmente (per documentare i progetti NET), ma ci sono diversi strumenti commerciali, e sono in grado di proporre prestazioni migliori e più caratteristiche, quindi se avete un budget per uno di loro, ne vale la pena almeno valutare quale valore potrebbe portare a voi.
