last_modified keyword in file header
Brought to you by:
m3t30r1c
It should be nice if the application recognise a keyword for indicating when the file was last modified. It should be read in the header of the file. For example:
/*! This is the header.
* This is a description of the file contents...
* ...
* @author John Doe
* @created 13/03/2013
* @modified 15/03/2013
*/
I'll think about this, in fact I don't think there's a need for user to hardcode
@modified
in the file because chances are they will forget to update this field in the future. What I can do on my end is to automatically scan the last modified date from the file and display that on the documentation, which I think is a more elegant solution and it is seamless to user.I think it will be better the approach I'm suggesting, since the last modified date in the operating system can be unrelated to the last time the programmer made a change in the source.
For instance, I often use the subversion tool, and I write, in my headers, the last modified date with the use of the corresponding keyword in subversion (see http://svnbook.red-bean.com/nightly/en/svn.advanced.props.special.keywords.html ).
Therefore, with my approach, once you'd write
@modified $Date$
the subversion will substitute that keyword correctly and therefore DocItOut will always show the correct date.
Regards.