I'm looking for a way to properly comment my stored procedure code so that I can extract the information into useful documentation ala something like XDOC (or C# equivalent). Something that's preferably lightweight would be ideal.
Asked
Active
Viewed 337 times
2 Answers
0
If you're already using Sandcastle to generate documentation based on the XML comments that Visual Studio generates, you might want to check out the following CodeProject project:
It shows you how you can use the tools you're already using to generate documentation for your SQL objects in the same style as the documentation you're already generating for the rest of your code.
Justin Niessner
- 242,243
- 40
- 408
- 536
0
Why not use extended properties which can be queried in a simple SQL statement?
SELECT * FROM sys.extended_properties
No need for any plug-ins, add-ons, or have a specific stored proc layout...
This is what we use for every object in our databases (and we also use Red Gate SQL Doc too to give some structure and a nice web site)
gbn
- 422,506
- 82
- 585
- 676
-
Because I want to see the comments for the procedure in the procedure itself the same way I see comments with code in my C# programs. – Orion Adrian Apr 29 '09 at 15:42
-
And have the ability to extract it separately too? – gbn Apr 29 '09 at 17:00