我是第一次为我的 SQL Server 表(从窗口Description
中的字段Properties
)编写描述,并且我开始思考在这样的字段中究竟要写什么。
例如,某些表格根据其标题是不言自明的……就像Albums
在“音乐系统”中调用的表格一样。在这种情况下,您实际上会写什么描述?
您通常在描述中包含哪些“其他”信息?你提到表的关系吗?
是否有一种标准的、正式的方式来为表格编写描述?
我是第一次为我的 SQL Server 表(从窗口Description
中的字段Properties
)编写描述,并且我开始思考在这样的字段中究竟要写什么。
例如,某些表格根据其标题是不言自明的……就像Albums
在“音乐系统”中调用的表格一样。在这种情况下,您实际上会写什么描述?
您通常在描述中包含哪些“其他”信息?你提到表的关系吗?
是否有一种标准的、正式的方式来为表格编写描述?
我相信一个好的对象命名和设计加上最终可以使您的数据库结构可视化的工具(例如 SQL Doc)比为每个对象添加详细描述要好得多。
您想在描述中涵盖的越多,它就越有可能与真实的数据库结构不同步。例如,如果您想记录关系,那么每次更改它时,您都需要记住更新描述(在所有涉及的对象上?)它基本上是冗余信息,因为它已经记录在模式中。我们不希望数据库冗余吗?
我还将包括该表与其他重要表的基数/关系。这似乎很明显,但通常并非如此。例如,对于 tblAddresses,您可能有以下描述:
"此表是地址明细行 (tblAddressLines) 的父表,由雇员表 (tblEmployees) 引用(而非子表)。
表描述应该使用 3 个简单的语句:一个描述表包含的内容,一个描述表中数据的初始状态(空或预填充),以及一个描述数据如何移入/移出表。
我会将使用该表的工作/程序/报告的名称放在描述中。这不太可能需要不断更新并回答为什么这个表存在的问题?(即这是谁的数据?)
如果您使用的是源代码控制,我想不出任何评论都不能更好地用作 SCC 评论。我认为这是多余的,除非您的组织有标准,否则不会使用它。