Generated files should have template source/file name in them
-------------------------------------------------------------
Key: CORE-89
URL: http://jira.andromda.org/browse/CORE-89
Project: AndroMDA Core
Type: Improvement
Reporter: Brent Verner
Assigned to: Chad Brandon
Attachments: template-comments.diff
_All_ generated files should have the name of the template from which the file
was generated.
Further, this should be a mentioned in the "Template Coding Conventions"
section of the
coding-conventions.html doc page.
I've made a quick && nasty pass at adding comments to all of the templates that
generate .java
files (see attached patch). It's _not_ as nice as the other "Generated by:"
messages, but
it is good enough to keep me from grepping about to find the template file.
Would it make more sense to do this as an ant <replace /> task and define a set
of tokens that
would be replaced before the files are jarred up? Something like...
@@COMMENT::FILENAME@@ -- template file name
@@COMMENT::OVERWRITTEN@@ -- warning that file is always overwritten
@@COMMENT::CUSTOMIZABLE@@ -- message that file can (and must) safely be
modified
@@COMMENT::LICENSE@@
-------------------------------------------------------
SF.Net email is Sponsored by the Better Software Conference & EXPO
September 19-22, 2005 * San Francisco, CA * Development Lifecycle Practices
Agile & Plan-Driven Development * Managing Projects & Teams * Testing & QA
Security * Process Improvement & Measurement * http://www.sqe.com/bsce5sf
