用于注释/记录.sql文件的约定

时间:2012-12-16 21:20:34

标签: mysql comment-conventions

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

3 个答案:

答案 0 :(得分:1)

我的回答是,由于评论过时,我大多停止评论,然后可能会产生误导,甚至比没有更糟糕。

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

答案 1 :(得分: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会这样做。

答案 2 :(得分:0)

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