Welcome Guest, Not a member yet? Register   Sign In
Documenting changes
#1

[eluser]James Gifford[/eluser]
Hi everyone.

I have been making extensive changes to CI's core libraries for a current project and I haven't been doing a great job of documenting the changes I made for future reference. I was just wondering what conventions other developers use when modifying someone else's code.

I'm currently going back and commenting any changes with my initials and a brief explanation of what I was thinking at the time. I wish now that I had commented out the original code and added my own rather than overwriting it.

Does anyone have any preferences for this sort of thing?


Messages In This Thread
Documenting changes - by El Forum - 11-13-2008, 08:44 PM
Documenting changes - by El Forum - 11-13-2008, 08:58 PM
Documenting changes - by El Forum - 11-13-2008, 09:01 PM
Documenting changes - by El Forum - 11-13-2008, 09:31 PM
Documenting changes - by El Forum - 11-13-2008, 11:57 PM



Theme © iAndrew 2016 - Forum software by © MyBB