Jak korzystać z plików dokumentacji XML

Question

1. Podczas korzystania z zewnętrznego zestawu, który jest dostarczany z plikiem dokumentacji XML, w jaki sposób uzyskać wizualne studio, aby go znaleźć?

2. Czy posiadając plik dokumentacji XML, czy istnieje plik transformacji programu lub xml lub coś, co mogę wykorzystać, aby spojrzeć na to w miły sposób? Niekoniecznie tak skomplikowany jak MSDN dokumentacja widza rodzaju lasera, ale przynajmniej coś ładniejszy niż czysta XML ...

Answer 1

1: wystarczy upuścić go w tym samym folderze co dll

2: to muszą być utrwalone? W przypadku użycia "na żywo" zarówno VS IDE, jak i "reflektor" umożliwiają przegląd dokumentacji (w odniesieniu do typów/członków/etc). Są narzędzia, które mogą to zmienić, ale nigdy się nie przejmowałem. Sandcastle może być warty obejrzenia, ale nigdy nie był dla mnie miły ;-p

Answer 2

odpowiedź na pierwsze pytanie: xml powinien mieć taką samą nazwę jak zespół i być tuż obok do tego. Jeśli więc masz zespół o nazwie Svish.dll, plik dokumentacji powinien być plikiem Svish.xml i znajdować się w tym samym katalogu.

Answer 3

1) Plik dokumentacji musi mieć taką samą nazwę jak nazwa zespołu, z dodanym rozszerzeniem ".xml" i znajdować się w tym samym katalog jako odpowiadający mu zestaw. Na przykład plik "MyCompany.MyNamespace.dll" i plik "MyCompany.MyNamespace.dll.xml" znajdują się w tym samym katalogu.

2) NDOC może generować różne formaty dokumentacji.

Answer 4

Odnośnie 2: Powinieneś być w stanie spojrzeć na "ładną wersję" dokumentacji za pomocą przeglądarki obiektów (Widok> Przeglądarka obiektów (Ctrl W + J)), a następnie przejrzyj swoją drogę do klasy, do której chcesz przejrzeć dokumentacja. Użyłem Przeglądarki obiektów, aby przejrzeć własną dokumentację, ponieważ jest ona bardziej przyjazna dla czytelnika niż pliki xml lub komentarze.