Question

I’m working on a C# project using a SQL Server 2008 database. There are 50+ tables in the database and from the name alone, the purpose of these tables and the columns within them aren’t immediately obvious. I want to create some form of documentation so future team members will know what the columns and tables do.

I’m looking for the SQL Server equivalent of C# “code comments” or “XML documentation on a method” – something a new person can glance at to gain understanding of a database table or column.

What are some options?

Answer 1

You can add extended properties

Viewing Extended Properties

e.g. displays all extended properties in the AdventureWorks2008R2 sample database

USE AdventureWorks2008R2;
GO
SELECT class, class_desc, major_id, minor_id, name, value
FROM sys.extended_properties;
GO

Fun with Extended Properties in SQL Server 2008