2010-11-17 6 views
7

Załóżmy, że masz bibliotekę C# z kilkoma funkcjami, wszystkie są ładnie wypełnione dokumentami ze standardowym /// <summary>. Odwołanie do projektu spowoduje, że funkcja i opis parametru pojawią się w pomocy kontekstowej programu Visual Studio. Ale czy to możliwe, aby mieć ten program, jeśli nie odwołujesz się do samego projektu, tylko do kompilacji (i potencjalnie do jakiegoś innego pliku z dokumentacją wewnątrz)?Jak uzyskać dokumentację XML dla przywoływanej biblioteki C#?

Odpowiedz

13

Tak jest - potrzebuje biblioteki mają być zbudowane z „plik dokumentacji XML” sprawdzonej tickbox (na stronach właściwości projektu)

alt text

Dzięki tej opcji zaznaczone proces budowania będzie teraz budować dodatkowy plik XML w katalogu wyjściowym, który zawiera całą dokumentację xml - ilekroć Visual Studio odwołuje się do zestawu przez plik, ładuje i wyświetla dokumentację intellisense z tego pliku XML (jeśli można go znaleźć).

alt text

powinny rozpowszechniać ten plik obok (w tym samym katalogu co) swój skompilowane biblioteki.