Hvordan bruke Hint og beskrivelse med Coldfusion

Coldfusion skriptspråk representerer et språk som programmerere kan legge inn direkte i HTML. Til tross for sin fleksibilitet, Coldfusion tilbyr programmerere omfattende verktøy for å forbedre ytelsen til sine manuskripter. For eksempel kan du legge til beskrivelser til Coldfusion funksjoner slik at andre programmerere kan forstå hva du har planlagt å gjøre med funksjonen. Du kan legge hint til funksjoner, slik at du kan vise meta-data om programmet med henblikk på introspeksjon.

Bruksanvisning

1 Definer en funksjon i en Coldfusion script. Den kan utføre nødvendige tiltak du ser passer:

<Cffunction name = "exampleFunction">
/

Vilkårlig kode /
</ Cffunction>

2 Gi funksjonen en beskrivelse. Denne beskrivelsen gir en kort beskrivelse av hva te funksjon gjør, eller hva det er ment å gjøre. Denne beskrivelsen gir andre programmerere et glimt på hva funksjonen gjør:

<Cffunction name = "exampleFunction",
description = "En funksjon for å telle kameler"

/

Vilkårlig kode /
</ Cffunction>

3 Gi funksjonen et hint. Dette attributtet fungerer med Coldfusion verktøy for å generere dokumentasjon for funksjonen. Coldfusion introspeksjon betyr at Coldfusion-verktøy kan se på Coldfusion Components og generere dokumentasjon om at funksjon og bruke som dokumentasjon i manuset. "Hint" tag er mer egnet til dette bruk deretter den generelle "description" tag:

<Cffunction name = "exampleFunction",
description = "En funksjon for å telle kameler"
hint = "En kamel telling funksjon som tar ingen argumenter og returnerer telles kameler"

/ Vilkårlig kode /
</ Cffunction>