Please start any new threads on our new
site at https://forums.sqlteam.com. We've got lots of great SQL Server
experts to answer whatever question you can come up with.
| Author |
Topic |
|
denis_the_thief
Aged Yak Warrior
596 Posts |
 Posted - 2011-06-22 : 02:36:52
|
| Do you have a change revision log at the top of your Stored Procedures? Or is that what Source Control Programs are for? Or is enough to just comment your changes?Is a comment in the Header describing what the Stored Procedure does mandatory? Or do you just have comments throughout the code? |
|
|
theboyholty
Posting Yak Master
226 Posts |
Posted - 2011-06-22 : 07:17:33
|
| Comments are never mandatory. You can put them in whenever you like. Personally I think it would be nice to have a header comment with update info (changes made and by whom) but in practice these never get updated so they are a waste of time.---------------------------------------------------------------------------------http://www.mannyroadend.co.uk The official unofficial website of Bury Football Club |
 |
|
|
denis_the_thief
Aged Yak Warrior
596 Posts |
Posted - 2011-06-22 : 10:47:20
|
quote:
Originally posted by theboyholty
Comments are never mandatory. You can put them in whenever you like. Personally I think it would be nice to have a header comment with update info (changes made and by whom) but in practice these never get updated so they are a waste of time.---------------------------------------------------------------------------------http://www.mannyroadend.co.uk The official unofficial website of Bury Football Club
Thanks - that's pretty much our shop. Just curious what other departments do/think. |
|
|
|
Lamprey
Master Smack Fu Yak Hacker
4614 Posts |
Posted - 2011-06-22 : 12:51:16
|
| My prefernce is to have a header with a change log that describes that last N changes (usually 4). And each change entry in the header MUST have a reference to a tracking number. In my case, this tracking number is a TFS Item Number (Changre Request or Bug or whatever). Of couse the actual code is checked in and out of TFS, so we can track changes over time there too.In addition that it's nice to have inline comments as needed to describe functionality or reasons why things are done a certain way. Assuming you have a standard established, how to handle people that are not following the standard is a different question altogether. :) |
|
|
|
|
|
|
Commenting Code