1

你们如何评论/记录您的 .sql 文件?是否有类似于 javadoc 之类的约定?在 facebook、twitter、google 等大型数据库密集型应用程序中通常会执行什么操作......

4

3 回答 3

1

我的回答是,随着评论过时,我基本上已经停止发表评论,然后可能会产生误导,甚至比没有评论更糟糕。

我现在尝试使我的对象(表、列、存储过程等)名称尽可能有意义。

于 2012-12-16T21:24:56.207 回答
1

我见过的 Javadoc 之类的 SQL 没有注释约定。不过,这将是向 Doxygen 人提出的一个很好的问题。

另一方面,一些 RDBMS 允许这样做:

COMMENT ON TABLE table_name IS 'This is a comment';
COMMENT ON COLUMN table_name.column_name IS 'This is a great column';

这更符合整个 RDBMS 的理念——一切都与数据有关。不过,我不知道有任何系统会生成很好的文档。另外,我认为这还不是标准的。

我不认为 MySQL 会以这种方式进行评论,但 Oracle 和 PostgreSQL 会这样做。

于 2012-12-16T21:28:35.087 回答
0

我不知道任何标准或工具。但我在开头使用注释块,有时会解释复杂的子句

于 2012-12-16T21:28:26.967 回答