Встроенная документация по пакетам Pl / SQL

Question

Я пытаюсь более полно документировать наши пакеты базы данных как API. Что бы мы хотели, это что-то вроде JavaDocs для PL / SQL. Я видел несколько инструментов (pldoc, plsqldoc), но хотел бы узнать от людей, которые их используют, как они сравнивают.

Answer 1

Я использовал PlDoc и считаю его действительно хорошим. Я не использовал никаких других инструментов, поэтому не могу сравнить. Я обнаружил, что PlDoc хорошо справился с основами. Мне нужны были более продвинутые функции, поэтому я создал собственный инструмент, который добавил расширения в PlDoc для большего количества тегов. Кроме того, я не просто делаю с ним документацию, я также генерирую заголовки наших пакетов, используя некоторые теги PlDoc (например, @private).

Я рекомендую вам попробовать PlDoc, а затем настроить то, что не соответствует вашим потребностям. Настройка не занимает много времени, поэтому не стоит тратить много времени, чтобы попробовать.

Answer 2

Я использую NaturalDocs уже несколько лет и считаю, что его легко установить и использовать. Это очень похоже на JavaDocs и поддерживает несколько языков, хотя я использовал его только с PL / SQL. Очень настраиваемый, хотя я не счел необходимым возиться с этим.