Re: Autodocumenting plpgsql function
От | Rémi Cura |
---|---|
Тема | Re: Autodocumenting plpgsql function |
Дата | |
Msg-id | CAJvUf_vA6Zt9_tZXiYC=jtrVcFRmDZ+GRtTMoW3ULZpTStxJRw@mail.gmail.com обсуждение исходный текст |
Ответ на | Re: Autodocumenting plpgsql function (Albe Laurenz <laurenz.albe@wien.gv.at>) |
Ответы |
Re: Autodocumenting plpgsql function
|
Список | pgsql-general |
Hey thanks for the answer.
I'm thinking way more than that.Rémi-C
2013/11/26 Albe Laurenz <laurenz.albe@wien.gv.at>
I am not sure what you need, but I see two ways toRémi Cura wrote:
> somebody knows of a way to autodocument plpgsql function, in a docxygen style
> (adding tags in comments for instance, or creating doc templates to fill).
>
> It would really help to write the doc and maintain it.
document a function:
1) With /** .. */ comments in the beginning.
Maybe doxygen can be used to parse a database dump.
2) With COMMENT ON FUNCTION ... IS '...';
That also keeps the documentation close to where
the code is, and it shows up in database dumps.
Yours,
Laurenz Albe
В списке pgsql-general по дате отправления: