2009-08-26 9 views
7

Próbuję pełniej dokumentować nasze pakiety baz danych jako interfejs API. To, co chcielibyśmy, to coś takiego jak JavaDocs dla PL/SQL. Widziałem tam kilka narzędzi (pldoc, plsqldoc), ale chciałbym wiedzieć od ludzi, którzy używają ich w porównaniu.Dokumentacja wbudowana w pakiet Pl/SQL

Odpowiedz

6

Użyłem PlDoc i uważam, że jest naprawdę dobry. Nie użyłem żadnych innych narzędzi, których nie można porównać. Znalazłem PlDoc dobrze. Chciałem trochę bardziej zaawansowanych funkcji, więc stworzyłem własne narzędzie, które dodało rozszerzenia do PlDoc, aby uzyskać więcej tagów. Nie robię tego również z dokumentacją. Generuję również nagłówki pakietów za pomocą niektórych tagów PlDoc (np. @private).

Polecam wypróbować PlDoc, a następnie poprawić wszystko, co nie spełnia Twoich potrzeb. Nie wymaga tak długiego czasu, aby zainwestować, więc nie jest to zbyt duża inwestycja, aby go wypróbować.

2

Używam już od kilku lat NaturalDocs i stwierdziłem, że jest łatwy w instalacji i obsłudze. To prawie jak JavaDocs i obsługuje wiele języków, chociaż użyłem go tylko z PL/SQL. Bardzo konfigurowalny, chociaż nie uważam za konieczne manipulowanie nim.

+0

Prawdopodobnie nie znalazłbym tego konkretnego narzędzia bez twojej odpowiedzi. Chociaż całkiem przystępny, myślę, że bardziej sztywne struktury rozwiązanie jest to, co nasz zespół potrzebuje. Dzięki! –