.net komentarz XML w dokumentacji API

głosy
15

Czy istnieje prosty sposób na tworzenie dokumentacji MSDN-styl z wyjściowego Visual Studio XML?
Nie mam pacjenta wystarczy założyć dobrą XSLT dla niej, bo wiem, że nie jestem pierwszą osobą, aby przejechać przez ten most.

Również próbowałem konfigurowania sandcastle niedawno, ale to naprawdę moje oczy krzyż. Albo mi brakuje czegoś ważnego w procesie lub jest po prostu zbyt zaangażowany.

Znam kogoś, kto tam jest naprawdę ładny martwe proste rozwiązanie.

Ja jeszcze raz podkreślić, ponieważ myślę, że moja formatowanie wykonane że ust non-zachęcający do czytania:

Dałem sandcastle spróbować, ale mieliśmy naprawdę twardy czas coraz to skonfigurować. Co tak naprawdę mają na myśli coś znacznie prostsze.

Oznacza to, że chyba po prostu nie zrozumieć proces sandcastle. Wydawało się, że strasznie dużo dodatkowego bagażu do mnie po prostu produkować coś miłego dla testerów pracować.

Utwórz 03/08/2008 o 23:03
źródło użytkownik
W innych językach...                            


6 odpowiedzi

głosy
9

Szukasz Sandcastle

Projekt strony: Komunikaty Sandcastle

Blog: Sandcastle blog

NDoc Code Generator Documentation NET kiedyś narzędziem wyboru, ale wsparcie ma wszystko, ale zatrzymał się.

Odpowiedział 03/08/2008 o 23:12
źródło użytkownik

głosy
5

Warto również skorzystać z Sandcastle Help File Builder. Zapewnia Ci ndoc jak GUI do generowania plików pomocy, więc nie trzeba robić nic z wiersza poleceń.

Witamy w Sandcastle Help File Builder Projektu

Odpowiedział 19/09/2008 o 16:22
źródło użytkownik

głosy
5

Wystarczy popatrzeć na Sandcastle , który robi dokładnie to. Jest to także jeden z bardziej prostszych rozwiązań tam, i to bardziej lub mniej narzędziem wyboru, więc na dłuższą metę, może moglibyśmy pomóc skonfigurować Sandcastle jeśli podasz jakie problemy napotkali Państwo podczas instalacji?

Odpowiedział 03/08/2008 o 23:14
źródło użytkownik

głosy
3

Śledź ten prosty 5 krok po kroku i jesteś dość dużo zrobić. Jako bonus można wykorzystać H2Viewer aby zobaczyć pliki HTML Help 2.x.

Odpowiedział 04/08/2008 o 11:31
źródło użytkownik

głosy
3

Właśnie skonfigurować Sandcastle ponownie. Spróbuj zainstalować go (uwalnianie maj 2008) i szukać SandcastleGui.exe lub coś podobnego (jest w folderze przykładów lub tak).

Kliknij przycisk Dodaj, montaż i dodaj swoją zespołu lub zespołów, dodawać żadnych plików .xml dokumentacja (te wygenerowane przez kompilator jeśli włączona tej opcji), a następnie zbudować.

To zajmie trochę czasu, ale wynik będzie warta wysiłku. To rzeczywiście patrzeć rzeczy z MSDN, więc otrzymaną dokumentację będą mieli również dziedziczenia klas w dół do System.Object z linkami do MSDN i rzeczy.

Sandcastle wydaje się nieco skomplikowane na początku, zwłaszcza, gdy chcesz użyć go w zautomatyzowanej produkcji, ale jestem absolutnie pewien, że będzie warte wysiłku.

Mają również do obejrzenia Sandcastle Builder Pomoc pliku , jest to nieco bardziej zaawansowane GUI dla niego.

Odpowiedział 04/08/2008 o 11:27
źródło użytkownik

głosy
2

Używam NDoc3

Odpowiedział 21/02/2010 o 23:12
źródło użytkownik

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