Come usare Hint e descrizione con ColdFusion

September 11

Il linguaggio di scripting ColdFusion rappresenta un linguaggio che i programmatori possono incorporare direttamente in HTML. Nonostante la sua flessibilità, ColdFusion offre ai programmatori strumenti completi per migliorare le prestazioni dei loro script. Ad esempio, è possibile aggiungere descrizioni alle vostre funzioni ColdFusion in modo che altri programmatori possono capire cosa si prevede di fare con la funzione. È possibile aggiungere suggerimenti per le funzioni, in modo da poter visualizzare meta-dati sul programma per scopi di introspezione.

istruzione

1 Definire una funzione in uno script ColdFusion. E 'in grado di eseguire qualsiasi azione si vede in forma:

<Nome cffunction = "exampleFunction">
/

Codice arbitrario /
</ Cffunction>

2 Dare la funzione di una descrizione. Questa descrizione fornisce una breve descrizione di ciò che te la funzione fa, o quello che è destinato a fare. Questa descrizione dà altri programmatori uno sguardo a ciò che la funzione fa:

<Nome cffunction = "exampleFunction",
description = "Una funzione per contare i cammelli"

/

Codice arbitrario /
</ Cffunction>

3 Dare la funzione di un suggerimento. Questo attributo funziona con strumenti ColdFusion per generare la documentazione per la funzione. ColdFusion introspezione significa che gli strumenti ColdFusion possono guardare componenti ColdFusion e generare documentazione su quella funzione e l'uso che la documentazione nello script. Il tag "suggerimento" è più adatto per questo uso il tag generale "description":

<Nome cffunction = "exampleFunction",
description = "Una funzione per contare i cammelli"
suggerimento = "Una funzione di conteggio cammello che non ha argomenti e restituisce cammelli contati"

/ Codice arbitrario /
</ Cffunction>