DocProject vs Sandcastle Help GUI File Builder

StackOverflow https://stackoverflow.com/questions/319632

  •  11-07-2019
  •  | 
  •  

Domanda

Ho diversi progetti C # insieme ad alcuni componenti di libreria interna che sto cercando di documentare insieme. Sandcastle sembra essere il posto dove andare per generare documentazione da C #. Vorrei sapere quale dei due, DocProject o Sandcastle Help File Builder GUI è migliore e supporta le funzionalità di cui ho bisogno.

Vorrei compilare solo ogni progetto che possiede una parte del documento e poi alla fine è tutto integrato. (vale a dire i componenti della libreria in un progetto di documentazione e ogni progetto nel proprio progetto di documentazione, quindi tutto quanto sopra in un'unica radice usando il visualizzatore della Guida 2)

È stato utile?

Soluzione

Posso garantire per Sandcastle Help File Builder. Funziona davvero bene e puoi documentare qualsiasi numero di assiemi all'interno di un progetto File Builder di Sandcastle Help. In teoria, potresti avere un progetto Builder e generare un documento per ogni progetto C # e quindi avere un progetto Builder master che documenta tutto.

Altri suggerimenti

Non ho usato DocProject ma sembra un prodotto con capacità paragonabili a Sandcastle.

Ho usato Sandcastle e lo trovo uno strumento efficace. Devi anche Sandcastle Help File Builder (SHFB) per darti un buon front-end, come altri hanno già detto Qui. Inoltre, è necessario Sandcastle Styles per le patch a livello di presentazione al motore Sandcastle. Mentre tutti e tre questi componenti avevano una nuova versione a metà del 2010, sto posticipando l'aggiornamento dalla versione 2008 a causa di un difetto di rendering in Firefox 3.6 (documentato nella voce 2010.09.06 di questo rapporto sui difetti ).

Ho documentato a fondo la mia esperienza con la piattaforma descrivendo quel problema e una varietà di altri che potresti aver bisogno o che desideri prendere in considerazione per produrre un set di documentazione ordinato e professionale. Il mio articolo " Taming Sandcastle: una guida per programmatori .NET alla documentazione del codice " è stato appena pubblicato su Simple-Talk.com a settembre 2010; potrebbe farti risparmiare te un po 'di tempo, fatica e agonia :-).

Doc Project produce documenti più raffinati - quando funziona - che non è sempre. È un prodotto molto più flakey.

Sandcastle Help File Builder è solido e porta a termine il lavoro.

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top