Jakie narzędzie może generować dokumentację HTML z kodu C #, jak Javadoc może zrobić dla Javy?

Question

view on stackexchange narkive permalink

Programiści języka Java mogą łatwo generować dokumentację HTML na podstawie ich kodu Java, co jest wygodnym sposobem publikowania interfejsów API online. To to przykład.

Czy istnieje podobne narzędzie dla kodu C #?

Musi być darmowy, najlepiej open source.

Musi działać przynajmniej w systemach Windows i Linux.

Ramki HTML nie są potrzebne, narzędzia, które generują tylko jedna długa strona HTML też jest idealna.

Answer 1

view on stackexchange narkive permalink

Doxygen wydaje się być tym, co by działało dla Ciebie.

• Może generować przeglądarkę dokumentacji on-line (w HTML) i / lub wyłączyć -line podręcznik referencyjny (w $ \ mbox {\ LaTeX} $) z zestawu udokumentowanych plików źródłowych.
• Obsługiwane jest również generowanie danych wyjściowych w formacie RTF (MS-Word), PostScript, hiperłączami PDF, skompresowanym HTML i stronami podręcznika Unix.
• Dokumentacja jest pobierana bezpośrednio ze źródeł, co znacznie ułatwia zachowanie zgodności dokumentacji z kodem źródłowym.

Można go użyć do generowania dokumentacji z C #, wraz z innymi językami, takimi jak C, Objective-C, PHP, Java, Python.

Answer 2

view on stackexchange narkive permalink

Możesz to zrobić za pomocą zwykłego kompilatora C # firmy Microsoft. Chociaż nie jest to oprogramowanie typu open source. Debiutuje za darmo, ponieważ wykorzystuje narzędzia, które już masz.

Dla pliku C # o nazwie XMLsample.cs

  csc XMLsample.cs / doc : XMLsample.xml  

utworzy plik xml XMLsample.xml . Stosując do tego arkusz stylów, będziesz mieć ładną stronę internetową. CSS powinien wystarczyć, chociaż dla bardziej znaczącej zmiany może być konieczne użycie XSLT.

zobacz MSDN

---

Jest również dostępny w Mono C # kompilator. Mono C # jest darmowym i open source.

  mcs XMLsample.cs /doc:XMLsample.xml  

Zobacz Strona podręcznika Mono

Answer 3

view on stackexchange narkive permalink

Wstawiam moje 2c, ponieważ postępowałem zgodnie z zaakceptowaną odpowiedzią, ale okazuje się, że

Kompilator Microsoft C # wykonuje tylko niedopracowaną robotę. Oznacza to, że daje tylko plik xml. Ale aby mieć fajną stronę internetową, nadal będziesz musiał zastosować do niej jakiś arkusz stylów, i to jest miejsce, w którym most jest zepsuty - kompilator Microsoft C # tego nie robi, a obsługiwane przez Microsoft narzędzia, które to robią, Sandcastle Projekt CodePlex nie jest już aktywnie rozwijany przez firmę Microsoft.

Podsumowując, przyjęta odpowiedź może być dobra na rok 2014, ale już nie dobra na 2017.

Nowa odpowiedź to Sandcastle Help File Builder Erica Woodruffa pod adresem https://GitHub.com/EWSoftware/SHFB, która jest rozwidlona i oparta na istniejącym kodzie źródłowym Sandcastle.

Answer 4

view on stackexchange narkive permalink

Używamy Dokument! X i działa dla nas naprawdę dobrze. Otrzymujesz pełną dokumentację API z komentarzy, a arkusze stylów sprawiają, że wygląda bardzo, bardzo ładnie. Bardzo szybko reagują też na wsparcie.

W związku z tym nie jest darmowe. Ale ze względu na to, co zapewnia, myślę, że warto. (Wcześniej korzystaliśmy z darmowego programu, a nie doxygen, co okazało się zbyt drogie, biorąc pod uwagę czas.)