Comment Blocks

Owned by Geoff Bowers
Last updated: Aug 19, 2010Version comment
2 min read

Overview

Every ColdFusion template should have a standard comment block at the top. This helps identify what the code is about, and by standardising we can work toward an automated document generation tool.

<!--- @@Copyright: Daemon Pty Limited 1995-2008, http://www.daemon.com.au --->
<!--- @@License: GPL/LGPL --->
<!--- @@displayname: Display Title for the Template --->
<!--- @@Description: Extended plain english description of what the template does. --->
<!--- @@Developer: Geoff Bowers (modius@daemon.com.au) --->

The FarCry core code base is copyrighted to Daemon Pty Limited, Sydney Australia. There are few exceptions. Generally for legal reasons its easier to have the code base associated with a single copyright holder – of course we hope there are never any legal reasons for this to be important (wink)

Third-party libraries distributed with the FarCry code base retain their own copyright.

License

Needs updating to outline requirements for GPL/LPGL licensing introduced as at 5.x

FarCry is released under the "Common Public License 1.0", http://www.opensource.org/licenses/cpl.php. This is the same license that projects such as Eclipse were originally released under. Developers are allowed to create and distribute derivative works. Please read the complete license if you intend to use this product in a commercial environment.

Third-party libraries distributed with the FarCry code base retain their own license. FarCry should only be distributing code with licenses compatible with CPL. Notably GPL is not compatible.

Displayname

This should be a concise title for the template. This title will be used for documentation purposes so please consider what you put here.

Description

This should be a short description about the template. This description will be used for documentation purposes so please consider what you put here.

Developer

Looking at removing "Developer" as a reference all together. Ownership as a concept hasn't really worked, and kudos is detailed in fisheye.

The developer is the person currently responsible for the maintenance of the code. It does not necessarily mean that this developer was the person who actually wrote the code.

Obviously version control highlights who's done what.. but not necessarily who's really leading the charge. If you are working on significant changes to a template please update the developer reference.