Fusedocs

Because an individual fuse is supposed to be designed and coded as if it were unaware of the larger application using it, a formalized method should exist to describe everything that the fuse can assume and everything that it cannot. By carefully documenting every variable that a fuse is allowed to reference and every variable that a fuse is supposed to create, we can be assured minimum coupling by our most discrete units.

A Fusedoc appears at the top of every fuse. Here is an example Fusedoc:

 <!-- <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE fusedoc SYSTEM "http://fusebox.org/fd4.dtd"> <fusedoc fuse="act_deleteTask.cfm" language="ColdFusion" specification="2.0"> <responsibilities>I delete a task and any user_tasks associated with ...

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.