My Account   Contact Us    
  
» HomeProductsSupportDeveloper CommunityCompany
Missing DISPLAYNAME attribute
Use the DISPLAYNAME attribute to document a CFC or Function

Type: documentation
Severity: (3)

Incorrect example
<cfcomponent>
  <cffunction name="do"><cfreturn "it"></cffunction>
</cfcomponent>

Resolution

<cfcomponent hint="This component does things" displayname="Do Majig">
  <cffunction name="do" hint="IT returns" displayname="Do'er" returntype="string">
    <cfreturn "it">
  </cffunction>
</cfcomponent>
Explanation

Use the hint and displayname attributes in cffunction, and cfcomponent to document your functions and components. The values you use will be displayed in the CFC inspector (when you browse to the URL of a CFC), and they can also be used in introspection.

Sign up for our newsletter: | Subscribe with RSS: RSS
© ActivSoftware 1999 to 2005 | Privacy Statement