是否有在概念上類似於 javadoc 的 postgres 函式文件模式？

我主要是一名 Java 開發人員。今天我正在寫一些postgres函式。出於習慣，我一直嘗試使用類似 Javadoc 的註釋樣式來描述函式參數和返回類型來記錄這些函式。是否有官方或廣泛支持的模式來記錄 postgres 函式？

並非如此，但是在 Postgres 和許多其他 DBMS 供應商中，您可以評論各種數據庫對象，例如：

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

據我所知，您無法評論函式的單個參數。

對於文件的介紹，您可能需要查看：

http://schemaspy.org/

除了上面的答案，所有現代 Postgres 版本都允許輸入和輸出的命名參數。

例如：

CREATE FUNCTION check_password(user_name_in TEXT, password_in TEXT, out password_ok boolean) ....

然後您可以使用命名參數呼叫該函式。

SELECT check_password(user_name_in := 'public', password_in := 'xyzzy');

我發現為輸入和輸出創建更長但更清晰的名稱很有幫助。

引用自：https://dba.stackexchange.com/questions/247100