.net komentář XML do API dokumentace

hlasů
15

Existuje jednoduchý způsob, jak produkovat dokumentaci MSDN stylu z Visual Studio XML výstup?
Nejsem pacientovi stačí nastavit dobré XSLT za to, protože vím, že nejsem první člověk přejít tento most.

Také jsem se snažil o zřízení hrad z písku v poslední době, ale je to opravdu dělal oči kříž. Buď mi chybělo něco důležitého v procesu, nebo je to prostě příliš zapojen.

Znám někoho, kdo tam má opravdu pěkný mrtvý-jednoduchá řešení.

Jsem tady opakuje, protože myslím, že můj formátování také, že se odst non-lákavě číst:

Dal jsem hrad z písku zkusit, ale měl opravdu těžké dostat ji nastavit. Co mám vlastně na mysli, je něco mnohem jednodušší.

To znamená, že pokud já prostě nechápu hrad z písku procesu. Zdálo se to jako strašně moc zavazadla navíc se mi jen produkovat něco pěkného pro testery pracovat.

Položena 03/08/2008 v 23:03
zdroj uživatelem
V jiných jazycích...                            


6 odpovědí

hlasů
9

hledáte Sandcastle

Projekt Page: Sandcastle zprávy

Blog: Sandcastle Blog

NDoc Code Dokumentace Generator for .NET býval nástroj výběru, ale podpora je téměř zastavil.

Odpovězeno 03/08/2008 v 23:12
zdroj uživatelem

hlasů
5

Měli byste také použít Sandcastle Builder Help File. To vám poskytuje ndoc jako GUI pro vytváření souborů nápovědy, takže si nemusíte dělat nic z příkazového řádku.

Vítáme Vás na hrad z písku nápovědy Tvůrce souboru projektu

Odpovězeno 19/09/2008 v 16:22
zdroj uživatelem

hlasů
5

Podívejte se na Sandcastle , který dělá přesně to. Je to také jeden z více jednodušších řešení tam, a to je více či méně nástroj výběru, tak v dlouhodobém horizontu, že bychom mohli pomoci nastavit Sandcastle Zadáte-li jaké otázky jste se setkal během instalace?

Odpovězeno 03/08/2008 v 23:14
zdroj uživatelem

hlasů
3

Postupujte podle tohoto jednoduchého 5 podrobný článek a jste skoro hotovo. Jako bonus můžete použít H2Viewer k zobrazení nápovědy HTML 2.x soubory.

Odpovězeno 04/08/2008 v 11:31
zdroj uživatelem

hlasů
3

Právě jsem se znovu nastavit Sandcastle. Zkuste instalací (uvolňovací květen 2008) a hledat SandcastleGui.exe nebo něco podobného (to je ve složce příkladů nebo tak nějak).

Klepněte na tlačítko Přidat shromáždění a přidat své shromáždění či sestavy přidávat žádné XML soubory dokumentace (ty generovaných kompilátorem, pokud si tuto možnost povolena) a pak stavět.

Bude to trvat nějakou dobu, ale výsledek bude stát za tu námahu. To bude skutečně vypadat up věci z MSDN, takže výsledná dokumentace bude mít také třídy dědičnost celou cestu dolů do System.Object s odkazy na MSDN a další věci.

Hrad z písku se zdá být trochu složitější na první pohled, a to zejména, pokud chcete použít v automatizovaném sestavení, ale jsem si naprosto jistý, že to bude stát za tu námahu.

Se také podívat na Sandcastle Builder soubor nápovědy , to je poněkud vyspělejší GUI pro něj.

Odpovězeno 04/08/2008 v 11:27
zdroj uživatelem

hlasů
2

Používám NDoc3

Odpovězeno 21/02/2010 v 23:12
zdroj uživatelem

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more