Code Documentation

  • I use the code in the samples and Featured Scripts to learn new stuff - after only 28 years programming I have a lot to learn. But many items are complex, and the lack of simple descriptive documentation can make learning more challenging. Please add text to procs and functions which explain the algorithms. Nothing complex, but make it easier for me to modify for my application. For example, the GetHolidays function might be extended to more holidays if it were explained.

    Thanks

  • Good suggestions. Documentation always helps, but I have to admit that I'm torn as to how much to add. To me, many scripts shouldn't be run by someone other than an experienced DBA and I would expect an experienced DBA could decode most of it with minimal docs.

    I know people need to learn, but I think specific questions about sections of the code might be the best way.

    Steve Jones

    sjones@sqlservercentral.com

    http://www.sqlservercentral.com/columnists/sjones

    http://www.dkranch.net

Viewing 2 posts - 1 through 1 (of 1 total)

You must be logged in to reply to this topic. Login to reply