documentation-generation

5Ciepło

2Odpowiedz

Narzędzie podobne do JavaDoc dla skryptów SQL

Czy są dostępne narzędzia do dokumentowania skryptów T/SQL, takich jak JavaDocs? Na przykład, chcę być w stanie udokumentować swoje skrypty, które zawierają instrukcje jak utworzyć w następujący sposó

12Ciepło

1Odpowiedz

Scaladoc [przypadek użycia]

Dlaczego niektóre opisy metod w Scaladoc zaczynają się od [use case]? Przykład: scala.collection.immutable.StringOps.++ Czy to tylko zastępczy zostać zastąpiony w przyszłości?

27Ciepło

2Odpowiedz

Jak dokumentować kod Pythona: Epydoc, doxygen, Sphinx, ...?

Nie jestem pewien, czy powinienem użyć Epydoc lub doxygen do dokumentowania mojego kodu Pythona. Obecnie wolałbym Epydoc, ponieważ jest wyspecjalizowany w Pythonie, a jego składnia nie różni się zbytn

5Ciepło

1Odpowiedz

Jak mogę utworzyć plik, który dokumentuje tylko "publiczne" API w Doxygen

Mam projekt, nad którym pracuję, czyli bibliotekę . Muszę udokumentować elementy wewnętrzne kodu biblioteki dla własnych celów, ale muszę również dostarczyć dokument API do moich użytkowników, w jaki

7Ciepło

1Odpowiedz

Jak uzyskać dokumentację XML dla przywoływanej biblioteki C#?

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

24Ciepło

2Odpowiedz

Jak piszesz swoją dokumentację pakietu?

Nie do końca zrozumiałem sensowny przepływ pracy dla budowania pakietów i pisania ich dokumentacji. Chcę, aby jak najwięcej procesu (i dokumentacji) było generowane automatycznie. Oczywistym sposobem

47Ciepło

3Odpowiedz

Automatyczne generowanie dokumentacji dla wszystkich zawartości pakietu Python

Próbuję automatycznie generować podstawową dokumentację dla mojej bazy kodów za pomocą Sphinx. Mam jednak trudności z instruktażem Sphinx do rekurencyjnego skanowania moich plików. Mam Python codebase

5Ciepło

1Odpowiedz

Korzystanie reStructuredText i Sfinksa dołączyć preformatowany plik

próbuję uczynić tę pracę fragment: Version History --------------- These are the versions over time:: .. include:: ../../CHANGES.txt Oznacza to, że korzystać z dyrektywy obejmują tak, że pl

5Ciepło

2Odpowiedz

Używanie Doc-O-Matic (Express) z Delphi

Szukam narzędzia do generowania dokumentacji kodu źródłowego Delphi, i chcę spróbować Doc-O-Matic Express (która jest darmowa). Czy są jakieś wskazówki dla początkujących, jak używać Doc-O-Matic Expre

21Ciepło

3Odpowiedz

Grails: Alternatives to Grails Doc?

Dokumentacja utworzona przez uruchomienie grails doc nie jest w pełni satysfakcjonująca w moich oczach. Na przykład działania w kontrolerach pojawiają się jako właściwości w dokumentacji, chociaż chci