Elements of Fusedoc

When you get right down to it, Fusedocs are really basic collections of information. They describe what a fuse is going to do (its Responsibilities); who created it, when, and why (its Properties); what variables are present when it runs and are to be created by it (its Input-Output, or IO); and what kinds of situations it expects (its Assertions).

Of these areas, only Responsibilities is a required section in any Fusedoc. The others can be used at your discretion. Keep in mind, though, the first rule of Fusedocs.

Responsibilities, Properties, and IO sections are commonly found in most Fusedocs, whereas an Assertions section is a bit more esoteric. In this section, we’ll look at Responsibilities, Properties, and Assertions. ...

Get Fusebox: Developing ColdFusion® Applications now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.