2008-10-14 10 views
23

Mam zestaw zawierający bardzo dokładną dokumentację opartą na XML, która jest używana przez Sandcastle do generowania plików pomocy dla produktu. Używamy również wyjściowych plików XML do zapewniania odpowiedniego IntelliSense w Visual Studio, gdy programiści w sposób oczywisty korzystają z tego zestawu.Umieszczenie dokumentacji Intellisense Xml w zestawie?

W tym celu wydaje się, że zarówno dostarczamy użytkownikowi zestaw ("assembly.dll"), jak i dokumentację ("assembly.xml").

Czy w jakiś sposób można osadzić dokumentację w zespole, więc musielibyśmy dostarczyć tylko jeden plik-zestaw, a Visual Studio byłoby w stanie wyodrębnić informacje? Może osadzony jako zasób lub coś w tym stylu?

Odpowiedz

13

Niestety, będziesz musiał dostarczyć oba, ponieważ Visual Studio wie tylko, aby spojrzeć na dokumenty XML dla Intellisense.

+1

Wstyd. Równoważna dokumentacja jest osadzona w serwerach COM (DLL). Trudno sobie wyobrazić, że zwiększyłoby to rozmiar pliku. – MarkJ

1

Czy brakuje czegoś? Zawsze komentuję jak zwykle (za pomocą 3 ukośników lub 3 znaczników (vb)), użyj wbudowanych znaczników xml i kiedy używam zestawu, otrzymuję intellisense - rzadko korzystam z zewnętrznego pliku xml.

+2

Czy otrzymujesz IntelliSense tak, jak przy kodowaniu, czy faktycznie dostajesz dokumentację, którą napisałeś? To znaczy. VS może automatycznie generować listingi metod i ich parametry i tak oczywiście, ale dopóki nie upewnię się, że dokumentacja jest dostępna również na komputerze-hoście, nie otrzymuję dokumentów. – ulrikj

5

Jeśli wyszukasz C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727, zobaczysz, że wszystkie zestawy .net, do których odwołujesz się w swoich aplikacjach, używają plików xml. Visual Studio dostarczy tylko intellisense dla złożeń, jeśli plik xml istnieje. Na przykład, jeśli chcesz zamknąć program Visual Studio, a następnie usunąć plik System.Drawing.xml, a następnie ponownie otworzyć VS, nie powinno być żadnych intellisense dla tego zestawu. Następnie trzeba zamknąć VS, skopiować go, a następnie ponownie otworzyć VS, aby intellisense działał ponownie.

+0

Właściwie, jeśli usuniesz plik XML, wciąż jest _some_ Intellisense. Nie zobaczysz żadnych komentarzy "///", ale nadal będziesz otrzymywać sygnatury metod i ich przeciążenia. Można przypuszczać, że odbywa się to poprzez refleksję. –

Powiązane problemy