是否存在与 javadoc 概念类似的 postgres 函数文档模式？

Question

我主要是一名 Java 开发人员。今天我正在写一些 postgres 函数。出于习惯，我一直尝试使用类似 Javadoc 的注释风格来描述函数参数和返回类型来记录这些函数。是否有官方或广泛支持的模式来记录 postgres 函数？

Answer 1

事实并非如此，但是在 Postgres 和许多其他 DBMS 供应商中，您可以对各种数据库对象进行评论，例如：

COMMENT ON FUNCTION my_function (timestamp) IS 'Returns Roman Numeral';

据我所知，您无法对函数的各个参数进行评论。

对于文档的演示，您可能需要查看：

http://schemaspy.org/