...
Flagging Code As Deprecated
Issue Tracking
Ensure you have:
- Created a ticket in the community bug tracker that explains why the code is being deprecated and is flagged as issue type "Deprecated".
- Added the ticket subject and number to your commit log; eg. FC-123: this code has been deprecated blah, blah
- Resolve/Close ticket and assigned to the correct Fix Version
Good work!
Inline Code
As a core developer you can flag deprecated code by including this following snippet:
| Code Block | ||
|---|---|---|
| ||
<cfimport taglib="/farcry/core/tags/farcry" prefix="farcry" />
<farcry:deprecated message="../admin/navajo/edit.cfm should be replaced by call to ../conjuror/invocation.cfm" />
|
The log message should specify what deprecated feature is being used and the alternative feature/function that should be used in its stead.
Innards
| Code Block | ||
|---|---|---|
| ||
<cfsetting enablecfoutputonly="true"> <!--- @@Copyright: Daemon Pty Limited 1995-2007, http://www.daemon.com.au ---> <!--- @@License: Released Under the "Common Public License 1.0", http://www.opensource.org/licenses/cpl.php ---> <!--- @@displayname: Deprecated Tag ---> <!--- @@description: As a core developer you can flag deprecated code by using this tag to pass in a deprecated message ---> <!--- @@author: Matthew Bryant (mbryant@daemon.com.au) ---> <cfif structkeyExists(application.log, " thistag.executionMode eq "Start"> <cfparam name="attributes.message" type="string" /> <cfif isdefined("application.log.bDeprecated") AND application.log.bDeprecated> <cftrace type="warning" inline="false" text="#GetBaseTemplatePath()# - #attributes.message#" abort="false" /> <cflog file="deprecated" application="true" type="warning" text="Your message.#GetBaseTemplatePath()# - #attributes.message#" /> </cfif> |
...
</cfif>
<cfsetting enablecfoutputonly="false">
|