@VersionInfo

The @VersionInfo annotation takes a argument that represents the version of this component. A developer might use version control system supported keyword substitution for this. The example below shows the use of the Subversion keywords $Id to provide revision number, modification time, and developer name as version information record. Major version control systems (CVS, Subversion,...) either have a built-in support for this feature or it can be used in conjunction with external tools (Mercurial, GIT). Therefore this annotation should not only contain an arbitrary version number, but a full version record instead is good common practice.

Synopsis

Type

Scope

Example

!  @Description("CSMLite Plant Component")
...
!  @VersionInfo("$Id: ET.java 20 2008-07-25 22:31:07Z od $")
...
!  @Execute
SUBROUTINE Plant
...

Component repositories can use and present this information, archiving tools or documentation generators might pick this up too.