I always create a comment block like this:
If the change calls for a reference from a defect management tool or a feature, then you should include it here.
// -------------------------------------------------------------------------
// File: Partner_004010_850_inbound.map
//
// History:
// 2009-04-15 abaird Add default country code rule
// - Back end requires a specific country code, but partners often omit
// the N404 element. Add a rule to default US or CA for N404 if N402
// contains a valid state or province code.
//
// 2008-11-09 abaird Original version
// -------------------------------------------------------------------------
It is the literal text of this entry that I always paste into the Perforce changelist comments.
Every time you check out the map to make some changes, always write a few lines here to give a summary of what you changed.
Comments here are saved only in the source file and not compiled into the runtime at all, and therefore have no performance impact whatsoever. This is therefore an excellent way to maintain some change documentation.
No comments:
Post a Comment